[master] 06bd1e0c0 doc: Spelling galore aftermath, part 2
Dridi Boukelmoune
dridi.boukelmoune at gmail.com
Wed Sep 11 12:34:07 UTC 2024
commit 06bd1e0c0ec563f5d8e58f409e3923a66fa814a5
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date: Wed Sep 11 14:24:00 2024 +0200
doc: Spelling galore aftermath, part 2
Courtesy of inconsistent gmail search results.
This batch includes a generalized s/gzip'ed/gzipped/g edit on all files
matching. Since we accepted gzipped and gunzipped as the proper spelling
we might as well use it everywhere for consistency (mostly documentation
and code comments).
diff --git a/bin/varnishd/cache/cache_esi_deliver.c b/bin/varnishd/cache/cache_esi_deliver.c
index ba6b0412d..c4063f355 100644
--- a/bin/varnishd/cache/cache_esi_deliver.c
+++ b/bin/varnishd/cache/cache_esi_deliver.c
@@ -504,11 +504,11 @@ ved_bytes(struct ecx *ecx, enum vdp_action act,
}
/*---------------------------------------------------------------------
- * If a gzip'ed ESI object includes a ungzip'ed object, we need to make
- * it looked like a gzip'ed data stream. The official way to do so would
+ * If a gzipped ESI object includes a ungzipped object, we need to make
+ * it looked like a gzipped data stream. The official way to do so would
* be to fire up libvgz and gzip it, but we don't, we fake it.
*
- * First, we cannot know if it is ungzip'ed on purpose, the admin may
+ * First, we cannot know if it is ungzipped on purpose, the admin may
* know something we don't.
*
* What do you mean "BS ?"
@@ -589,7 +589,7 @@ static const struct vdp ved_pretend_gz = {
};
/*---------------------------------------------------------------------
- * Include a gzip'ed object in a gzip'ed ESI object delivery
+ * Include a gzipped object in a gzipped ESI object delivery
*
* This is the interesting case: Deliver all the deflate blocks, stripping
* the "LAST" bit of the last one and padding it, as necessary, to a byte
@@ -910,7 +910,7 @@ ved_deliver(struct req *req, struct boc *boc, int wantbody)
VCL_Req2Ctx(ctx, req);
if (ecx->isgzip && i && !(req->res_mode & RES_ESI)) {
- /* A gzip'ed include which is not ESI processed */
+ /* A gzipped include which is not ESI processed */
/* OA_GZIPBITS are not valid until BOS_FINISHED */
if (boc != NULL)
@@ -930,7 +930,7 @@ ved_deliver(struct req *req, struct boc *boc, int wantbody)
foo->objcore = req->objcore;
i = VDP_Push(ctx, req->vdc, req->ws, &ved_gzgz, foo);
} else if (ecx->isgzip && !i) {
- /* Non-Gzip'ed include in gzip'ed parent */
+ /* Non-Gzip'ed include in gzipped parent */
i = VDP_Push(ctx, req->vdc, req->ws, &ved_pretend_gz, ecx);
} else {
/* Anything else goes straight through */
diff --git a/bin/varnishd/cache/cache_esi_parse.c b/bin/varnishd/cache/cache_esi_parse.c
index b4148e72e..5145b016c 100644
--- a/bin/varnishd/cache/cache_esi_parse.c
+++ b/bin/varnishd/cache/cache_esi_parse.c
@@ -1132,7 +1132,7 @@ VEP_Finish(struct vep_state *vep)
lcb = vep->cb(vep->vc, vep->cb_priv, 0, VGZ_ALIGN);
vep_emit_common(vep, lcb - vep->o_last, vep->last_mark);
}
- // NB: We don't account for PAD+SUM+LEN in gzip'ed objects
+ // NB: We don't account for PAD+SUM+LEN in gzipped objects
(void)vep->cb(vep->vc, vep->cb_priv, 0, VGZ_FINISH);
AZ(VSB_finish(vep->vsb));
diff --git a/bin/varnishd/cache/cache_rfc2616.c b/bin/varnishd/cache/cache_rfc2616.c
index 38e302237..97f16ed9f 100644
--- a/bin/varnishd/cache/cache_rfc2616.c
+++ b/bin/varnishd/cache/cache_rfc2616.c
@@ -228,7 +228,7 @@ RFC2616_Ttl(struct busyobj *bo, vtim_real now, vtim_real *t_origin,
}
/*--------------------------------------------------------------------
- * Find out if the request can receive a gzip'ed response
+ * Find out if the request can receive a gzipped response
*/
unsigned
diff --git a/bin/varnishd/cache/cache_vary.c b/bin/varnishd/cache/cache_vary.c
index 101eca231..fa9053966 100644
--- a/bin/varnishd/cache/cache_vary.c
+++ b/bin/varnishd/cache/cache_vary.c
@@ -203,7 +203,7 @@ vry_cmp(const uint8_t *v1, const uint8_t *v2)
http_hdr_eq(H_Accept_Encoding, (const char*) v1 + 2)) {
/*
* If we do gzip processing, we do not vary on Accept-Encoding,
- * because we want everybody to get the gzip'ed object, and
+ * because we want everybody to get the gzipped object, and
* varnish will gunzip as necessary. We implement the skip at
* check time, rather than create time, so that object in
* persistent storage can be used with either setting of
diff --git a/bin/varnishd/cache/cache_vrt_filter.c b/bin/varnishd/cache/cache_vrt_filter.c
index 40236fd9b..4d777d464 100644
--- a/bin/varnishd/cache/cache_vrt_filter.c
+++ b/bin/varnishd/cache/cache_vrt_filter.c
@@ -347,8 +347,8 @@ vbf_default_filter_list(void *arg, struct vsb *vsb)
* The backend Content-Encoding header tells us what we are going
* to receive, which we classify in the following three classes:
*
- * "Content-Encoding: gzip" --> object is gzip'ed.
- * no Content-Encoding --> object is not gzip'ed.
+ * "Content-Encoding: gzip" --> object is gzipped.
+ * no Content-Encoding --> object is not gzipped.
* anything else --> do nothing wrt gzip
*/
@@ -364,11 +364,11 @@ vbf_default_filter_list(void *arg, struct vsb *vsb)
else
is_gunzip = 1;
- /* We won't gunzip unless it is gzip'ed */
+ /* We won't gunzip unless it is gzipped */
if (do_gunzip && !is_gzip)
do_gunzip = 0;
- /* We wont gzip unless if it already is gzip'ed */
+ /* We wont gzip unless if it already is gzipped */
if (do_gzip && !is_gunzip)
do_gzip = 0;
diff --git a/bin/varnishd/http2/cache_http2_proto.c b/bin/varnishd/http2/cache_http2_proto.c
index cf9d7b465..9a514e88b 100644
--- a/bin/varnishd/http2/cache_http2_proto.c
+++ b/bin/varnishd/http2/cache_http2_proto.c
@@ -603,7 +603,7 @@ h2_rx_settings(struct worker *wrk, struct h2_sess *h2, struct h2_req *r2)
}
/**********************************************************************
- * Incoming HEADERS, this is where the parties at...
+ * Incoming HEADERS, this is where the party's at...
*/
void v_matchproto_(task_func_t)
diff --git a/bin/varnishtest/tests/e00023.vtc b/bin/varnishtest/tests/e00023.vtc
index 08517c609..bfc8fd76b 100644
--- a/bin/varnishtest/tests/e00023.vtc
+++ b/bin/varnishtest/tests/e00023.vtc
@@ -1,4 +1,4 @@
-varnishtest "Include gzip'ed and ungzip'ed (ESI) objects in a gzip'ed ESI object"
+varnishtest "Include gzipped and ungzipped (ESI) objects in a gzipped ESI object"
server s1 {
rxreq
diff --git a/bin/varnishtest/tests/e00034.vtc b/bin/varnishtest/tests/e00034.vtc
index b0e93ba8e..352c44764 100644
--- a/bin/varnishtest/tests/e00034.vtc
+++ b/bin/varnishtest/tests/e00034.vtc
@@ -5,7 +5,7 @@ varnishtest "ESI requests, gzip and custom VDPs"
# To select the embedding vdps (gzgz / pretendgz), ESI currently only
# looks at the cache object's ESI status. So for VDP-processing an
-# include of a gzip'ed ESI object, we need to restore the encoding
+# include of a gzipped ESI object, we need to restore the encoding
# after filtering. Thus, we would currently need a gzip VDP to be able
# to use `set resp.filters += " gunzip rot13 gzip"`
#
diff --git a/bin/varnishtest/tests/r01184.vtc b/bin/varnishtest/tests/r01184.vtc
index d5aba3251..0988e65a3 100644
--- a/bin/varnishtest/tests/r01184.vtc
+++ b/bin/varnishtest/tests/r01184.vtc
@@ -1,4 +1,4 @@
-varnishtest "Corrupt gzip'ed ESI objects"
+varnishtest "Corrupt gzipped ESI objects"
# First, check that our data is actually good
diff --git a/doc/sphinx/phk/gzip.rst b/doc/sphinx/phk/gzip.rst
index 4882cd4e7..6a62bf346 100644
--- a/doc/sphinx/phk/gzip.rst
+++ b/doc/sphinx/phk/gzip.rst
@@ -25,7 +25,7 @@ will not experience any difference, this processing only affects
cache hit/miss requests.
Unless vcl_recv{} results in "pipe" or "pass", we determine if the
-client is capable of receiving gzip'ed content. The test amounts to:
+client is capable of receiving gzipped content. The test amounts to:
Is there a Accept-Encoding header that mentions gzip, and if
is has a q=# number, is it larger than zero.
@@ -54,14 +54,14 @@ always set to:
Even if this particular client does not support
-To always entice the backend into sending us gzip'ed content.
+To always entice the backend into sending us gzipped content.
Varnish will not gzip any content on its own (but see below), we trust
-the backend to know what content can be sensibly gzip'ed (html) and what
+the backend to know what content can be sensibly gzipped (html) and what
cannot (jpeg)
If in vcl_backend_response{} we find out that we are trying to deliver a
-gzip'ed object to a client that has not indicated willingness to receive
+gzipped object to a client that has not indicated willingness to receive
gzip, we will ungzip the object during deliver.
Tuning, tweaking and frobbing
@@ -84,13 +84,13 @@ gzip-ness of objects during fetch:
set beresp.do_gunzip = true;
-Will make varnish gunzip an already gzip'ed object from the backend during
+Will make varnish gunzip an already gzipped object from the backend during
fetch. (I have no idea why/when you would use this...)
set beresp.do_gzip = true;
Will make varnish gzip the object during fetch from the backend, provided
-the backend didn't send us a gzip'ed object.
+the backend didn't send us a gzipped object.
Remember that a lot of content types cannot sensibly be gzipped, most
notably compressed image formats like jpeg, png and similar, so a
@@ -115,8 +115,8 @@ In theory, and hopefully in practice, all you read above should apply also
when you enable ESI, if not it is a bug you should report.
But things are vastly more complicated now. What happens for
-instance, when the backend sends a gzip'ed object we ESI process
-it and it includes another object which is not gzip'ed, and we want
+instance, when the backend sends a gzipped object we ESI process
+it and it includes another object which is not gzipped, and we want
to send the result gzipped to the client ?
Things can get really hairy here, so let me explain it in stages.
@@ -139,15 +139,15 @@ the new URL and possibly Host: header, and call vcl_recv{} etc. You
can tell that you are in an ESI include by examining the 'req.esi_level'
variable in VCL.
-The ESI-parsed object is stored gzip'ed under the same conditions as
-above: If the backend sends gzip'ed and VCL did not ask for do_gunzip,
-or if the backend sends ungzip'ed and VCL asked for do_gzip.
+The ESI-parsed object is stored gzipped under the same conditions as
+above: If the backend sends gzipped and VCL did not ask for do_gunzip,
+or if the backend sends ungzipped and VCL asked for do_gzip.
Please note that since we need to insert flush and reset points in
the gzip file, it will be slightly larger than a normal gzip file of
the same object.
-When we encounter gzip'ed include objects which should not be, we
+When we encounter gzipped include objects which should not be, we
gunzip them, but when we encounter gunzip'ed objects which should
be, we gzip them, but only at compression level zero.
diff --git a/doc/sphinx/users-guide/compression.rst b/doc/sphinx/users-guide/compression.rst
index 3aca6f116..5409b6d76 100644
--- a/doc/sphinx/users-guide/compression.rst
+++ b/doc/sphinx/users-guide/compression.rst
@@ -34,7 +34,7 @@ Unless the request is a `pass`, Varnish sets `bereq.http.Accept-Encoding`
to "gzip" before `vcl_backend_fetch` runs, so the header can be changed
in VCL.
-If the server responds with gzip'ed content it will be stored in memory
+If the server responds with gzipped content it will be stored in memory
in its compressed form and `Accept-Encoding` will be added to the
`Vary` header.
diff --git a/doc/sphinx/users-guide/esi.rst b/doc/sphinx/users-guide/esi.rst
index 8920ed7c0..25be4e18a 100644
--- a/doc/sphinx/users-guide/esi.rst
+++ b/doc/sphinx/users-guide/esi.rst
@@ -209,7 +209,7 @@ Varnish does this compressing all parts of ESI responses
separately, and stitching them together on the fly during
delivery, which has a negative impact on compression ratio.
-When you ``set beresp.do_esi = True;`` on a gzip'ed response, it
+When you ``set beresp.do_esi = True;`` on a gzipped response, it
will be uncompressed and recompressed part-wise during the fetch.
The part-wise compression reduces the opportunities for
diff --git a/include/tbl/vsl_tags.h b/include/tbl/vsl_tags.h
index 5d50d8afc..9c1aae69d 100644
--- a/include/tbl/vsl_tags.h
+++ b/include/tbl/vsl_tags.h
@@ -481,7 +481,7 @@ SLTM(VCL_Error, 0, "VCL execution error message",
SLTM(Gzip, 0, "G(un)zip performed on object",
"A Gzip record is emitted for each instance of gzip or gunzip"
" work performed. Worst case, an ESI transaction stored in"
- " gzip'ed objects but delivered gunzipped, will run into many of"
+ " gzipped objects but delivered gunzipped, will run into many of"
" these.\n\n"
"The format is::\n\n"
"\t%c %c %c %d %d %d %d %d\n"
diff --git a/lib/libvarnish/vsb.c b/lib/libvarnish/vsb.c
index 61f119458..2a405987a 100644
--- a/lib/libvarnish/vsb.c
+++ b/lib/libvarnish/vsb.c
@@ -87,7 +87,7 @@ _assert_VSB_integrity(const char *fun, const struct vsb *s)
KASSERT(s != NULL,
("%s called with a NULL vsb pointer", fun));
KASSERT(s->magic == VSB_MAGIC,
- ("%s called with an bogus vsb pointer", fun));
+ ("%s called with a bogus vsb pointer", fun));
KASSERT(s->s_buf != NULL,
("%s called with uninitialized or corrupt vsb", fun));
KASSERT(s->s_len < s->s_size,
More information about the varnish-commit
mailing list