fix misspells and minor cleanup by MFTabriz · Pull Request #44 · squid-cache/squid-cache.github.io

MFTabriz · 2025-10-22T09:48:34Z

... and avoid using contractions to improve readability.

rousskov

Thank you for fixing these. What tool did you use to detect them? Did you have to do any manual processing to correct that tool mistakes?

docs/ConfigExamples/Intercept.md

docs/ConfigExamples/ClusteringTproxySquid.md

docs/DeveloperResources/RequestUseCases.md

docs/Features/CodeTestBed.md

docs/Features/ForwardRework.md

docs/KnowledgeBase/LdapBackedDigestAuthentication.md

MFTabriz · 2025-10-22T13:51:09Z

Thank you for fixing these. What tool did you use to detect them? Did you have to do any manual processing to correct that tool mistakes?

I usually use cspell, but it has many false positives, so you end up having to sift through them all.

Co-authored-by: Alex Rousskov <rousskov@measurement-factory.com>

MFTabriz · 2025-10-22T20:23:00Z

@rousskov Although some of these suggestions were not misspells, I went ahead and applied them all [and updated the PR info]. Let me know if anything else needs a fix.

rousskov

Almost done AFAICT, provided others are OK with removing contractions as tracked in a dedicated change request.

rousskov · 2025-10-22T21:28:19Z

docs/Features/NewLogging.md

    doesn't recycle those pages too quickly. Grr\!
 - Still, even at 10,000 req/sec with an average logging line length of
-    160 characters thats 1.52 megabytes a second of data to copy; not
+    160 characters that's 1.52 megabytes a second of data to copy; not


Suggested change

160 characters that's 1.52 megabytes a second of data to copy; not

160 characters that is 1.52 megabytes a second of data to copy; not

rousskov · 2025-10-22T21:34:52Z

docs/SquidFaq/AboutSquid.md

  Authentication

-# What's the legal status of Squid?
+# What is the legal status of Squid?


Although some of these suggestions were not misspells, I went ahead and applied them all

I did not mean to ask you to remove existing correct contractions. My comment was only about PR changes that added or changed contractions. Sorry for not being clear.

FWIW, I am not against removing existing/correct contractions (as this PR now does), but I certainly do not insist on it, and others may not like that idea.

rousskov · 2025-10-22T21:37:17Z

docs/SquidFaq/SquidProfiling.md


 - Make sure you've got the debugging libraries and library symbols
-    installed - under Ubuntu thats 'libc6-dbg'.
+    installed - under Ubuntu that's 'libc6-dbg'.


Suggested change

installed - under Ubuntu that's 'libc6-dbg'.

installed - under Ubuntu that is 'libc6-dbg'.

rousskov · 2025-10-22T21:38:06Z

docs/SquidFaq/TroubleShooting.md


 Then Squid opens a TCP connection to the destination host and port, and
-the *real* request is sent encrypted over this connection. Thats the
+the *real* request is sent encrypted over this connection. That's the


Suggested change

the *real* request is sent encrypted over this connection. That's the

the *real* request is sent encrypted over this connection. That is the

rousskov · 2025-10-22T21:38:50Z

docs/NewClientSide.md

 # Another Client Side?

-Or, "a new HTTP server side", as thats what it is.
+Or, "a new HTTP server side", as that's what it is.


Suggested change

Or, "a new HTTP server side", as that's what it is.

Or, "a new HTTP server side", as that is what it is.

rousskov · 2025-10-22T21:39:10Z

docs/NewClientSide.md

 - HTTP authentication? Or could that be implemented between the HTTP
    network server and the HTTP request queue?
- SSL. Thats a connection property.
+- SSL. That's a connection property.


Suggested change

- SSL. That's a connection property.

- SSL. That is a connection property.

yadij

Given the touched lines a look over.

Please add "cacheable" to your dictionary. It is one of the weird exceptional words that does not follow the rule in English about dropping the 'e' suffix - something about how Americans pronouce 'a-ch-a' sounds differently from English.

Quite a lot of inconsistency in contraction handling, IMO it should be done. Progress is still progress though, so I am good as long as the touched lines are correct.

Two major issues to decide:

when text is quoting a discussion. To expand contractions or not?
when typo is in the page/file name. To rename the file or not?

i.e. KnowledgeBase/UnparseableHeader.md - should be UnparsableHeader

yadij · 2025-10-23T03:44:09Z

docs/DeveloperResources/RequestUseCases.md

 11. the client

-## Uncacheable request
+## Uncacheble request


original word was correct spelling.

Suggested change

## Uncacheble request

## Uncacheable request

yadij · 2025-10-23T03:44:35Z

docs/DeveloperResources/RequestUseCases.md

 ## Tunnel request

-## Cachable request
+## Cacheble request


Original word was wrong, but so is the replacement.

Suggested change

## Cacheble request

## Cacheable request

yadij · 2025-10-23T03:49:36Z

docs/Features/CacheManager/Index.md

 used (and reloaded if/when needed). Data pages are also discarded if
-unmodified, and paged out if there's been any changes. Allocated memory
-(malloc) is always saved to disk since there's no executable file to
+unmodified, and paged out if there has been any changes. Allocated memory


temporal plural. has/have

Suggested change

unmodified, and paged out if there has been any changes. Allocated memory

unmodified, and paged out if there have been any changes. Allocated memory

yadij · 2025-10-23T03:51:19Z

docs/Features/CacheManager/IpCache.md

 ## FAQ about this report

-### What's the difference between a hit, a negative hit and a miss?
+###  i the difference between a hit, a negative hit and a miss?


manual typo?

Suggested change

### i the difference between a hit, a negative hit and a miss?

### What is the difference between a hit, a negative hit and a miss?

yadij · 2025-10-23T03:52:40Z

docs/Features/CollapsedForwarding.md

 there can be benefit from enabling this in accelerator setups where the
 web servers are the bottleneck but are reliable and return mostly
-cacheable information.
+cachable information.


original was correct

Suggested change

cachable information.

cacheable information.

yadij · 2025-10-23T04:32:10Z

docs/ConfigExamples/ContentAdaptation/EcapForExifStripping.md

        disk storage, otherwise processing will be done in RAM.
    exclude_types
-        List of semicolon seprated MIME types which shouldn't be
+        List of semicolon separated MIME types which shouldn't be


contraction

Suggested change

List of semicolon separated MIME types which shouldn't be

List of semicolon separated MIME types which should not be

yadij · 2025-10-23T04:32:36Z

docs/ConfigExamples/DynamicContent/YouTube.md

            logdata("MISS",$url,$fname);
            $fileptr=fopen($fname,"w");
-            //no validity check, simply don't write the file if we can't open it. prevents noticeable failure/
+            //no validity check, simply don't write the file if we cannot open it. prevents noticeable failure/


contraction

Suggested change

//no validity check, simply don't write the file if we cannot open it. prevents noticeable failure/

//no validity check, simply do not write the file if we cannot open it. prevents noticeable failure/

yadij · 2025-10-23T04:35:14Z

docs/ConfigExamples/WebwasherChained.md


 Since the configuration options in the web interface have moved between
-version 5.x and 6.x I won't describe the exact path. If you don't know
+version 5.x and 6.x I will not describe the exact path. If you don't know


contraction

Suggested change

version 5.x and 6.x I will not describe the exact path. If you don't know

version 5.x and 6.x I will not describe the exact path. If you do not know

yadij · 2025-10-23T04:36:19Z

docs/DeveloperResources/ClientStreams.md

@@ -130,7 +130,7 @@ organised...
 15:25 < lifeless> and likewise for the Detach static method
 15:26 < lifeless> is this making sense ?
 15:27 < nicholas> yes, but just let me reread a litt.e


typo

Suggested change

15:27 < nicholas> yes, but just let me reread a litt.e

15:27 < nicholas> yes, but just let me reread a little

yadij · 2025-10-23T04:39:59Z

docs/DeveloperResources/ClientStreams.md


 ```irc
-14:48 < nicholas> Hi. I'm working on bug 1160 (analyze HTML to prefetch embedded objects). I can't figure out why, but even though it
+14:48 < nicholas> Hi. I'm working on bug 1160 (analyze HTML to prefetch embedded objects). I cannot figure out why, but even though it


I'm not sure we should be fixing contractions when quoting a discussion. In either case the change has been applied inconsistently to this file. Some 's and 't suffix have been expanded and many have not - across lines both touched by other change, and not.

rousskov · 2025-10-23T13:49:52Z

Please add "cacheable" to your dictionary.

I have also asked to undo changes from "cachable" to "cacheable", but I am not sure that request had the desired effect.

Ideally, we should standardize on one spelling; "cachable" spelling is arguably prevalent in primary Squid sources (~124:52). We do not have to standardize in this PR though.

when text is quoting a discussion. To expand contractions or not?

IMHO, we should apply all the automated style/grammar/etc. rules to those discussions because those discussions are illustrations and documentation rather than copies of transcripts that must be preserved in their original form. We can add a "chat transcripts edited for clarity" or a similar disclaimer somewhere if really needed. I bet that most of those discussions should be removed as no longer helpful, but that would be a manual change that deserves dedicated study (and PRs).

when typo is in the page/file name. To rename the file or not?

i.e. KnowledgeBase/UnparseableHeader.md - should be UnparsableHeader

Rename -- if the problem can be fixed, it should be. If (and only if) we really want to keep some old links working (for a while), we can handle that on a case-by-base basis using HTTP redirection. I bet the number of cases where such redirects would be justified close to zero.

FWIW, changing section titles breaks existing links as well.

fix misspells

25f1889

rousskov requested changes Oct 22, 2025

View reviewed changes

use "cachable" and "requestor" spellings

e5f94c4

MFTabriz marked this pull request as draft October 22, 2025 14:10

MFTabriz and others added 2 commits October 22, 2025 22:16

avoid contractions

d67c72c

Update docs/ConfigExamples/Intercept.md

ef83435

Co-authored-by: Alex Rousskov <rousskov@measurement-factory.com>

MFTabriz force-pushed the main branch from 3f127fa to ef83435 Compare October 22, 2025 20:17

MFTabriz changed the title ~~fix misspells~~ fix misspells and minor cleanup Oct 22, 2025

MFTabriz marked this pull request as ready for review October 22, 2025 20:24

rousskov requested changes Oct 22, 2025

View reviewed changes

yadij requested changes Oct 23, 2025

View reviewed changes

	160 characters that's 1.52 megabytes a second of data to copy; not
	160 characters that is 1.52 megabytes a second of data to copy; not

	installed - under Ubuntu that's 'libc6-dbg'.
	installed - under Ubuntu that is 'libc6-dbg'.

	the real request is sent encrypted over this connection. That's the
	the real request is sent encrypted over this connection. That is the

	Or, "a new HTTP server side", as that's what it is.
	Or, "a new HTTP server side", as that is what it is.

	- SSL. That's a connection property.
	- SSL. That is a connection property.

	unmodified, and paged out if there has been any changes. Allocated memory
	unmodified, and paged out if there have been any changes. Allocated memory

	### i the difference between a hit, a negative hit and a miss?
	### What is the difference between a hit, a negative hit and a miss?

	List of semicolon separated MIME types which shouldn't be
	List of semicolon separated MIME types which should not be

	//no validity check, simply don't write the file if we cannot open it. prevents noticeable failure/
	//no validity check, simply do not write the file if we cannot open it. prevents noticeable failure/

	version 5.x and 6.x I will not describe the exact path. If you don't know
	version 5.x and 6.x I will not describe the exact path. If you do not know

	15:27 < nicholas> yes, but just let me reread a litt.e
	15:27 < nicholas> yes, but just let me reread a little

Conversation

MFTabriz commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rousskov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MFTabriz commented Oct 22, 2025

Uh oh!

MFTabriz commented Oct 22, 2025

Uh oh!

rousskov left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yadij left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rousskov commented Oct 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MFTabriz commented Oct 22, 2025 •

edited

Loading

rousskov left a comment •

edited

Loading