Boulder: Codespell report for the "boulder" project

[jschleus]

As administrator of the FOSS server fossies.org I have just created for testing purposes a codespell based analysis for the "boulder" release "2020-01-06":

https://fossies.org/linux/www/boulder/codespell.html

That version-independent (not linked) URL should redirect always to the last report (if available), so currently to

https://fossies.org/linux/www/boulder-release-2020-01-06.tar.gz/codespell.html

Although after a first review some obviously wrong matches ("False Positives" = FPs) are already filtered out (ignored) please inform me if you find more of them so that I can force a new improved check if applicable.

Just for information there are also two supplemental pages https://fossies.org/linux/www/boulder/codespell_conf.html (showing some used "codespell" configurations) and https://fossies.org/linux/www/boulder/codespell_fps.html (showing all resulting obvious "False Positives").

Two small remarks: I ranked the 5 occurrences of the word "keypair" as FPs but I found also 20 occurrences with the spelling "key pair" (a inconsistency?). The word "ot" in the line 449 of the file cmd/ocsp-updater/main.go is automatically ranked by fossies.org as FP (since containing only two letters) but it seems to be also a real typo.

By the way, the overall rating grade of this Fossies source code misspelling report is really good: "A-"

[cpu]

Thanks @jschleus, this is an interesting project and I appreciate you filing an issue about it. :-)

We'll give the output a once-over and fix the relevant typos.

By the way, the overall rating grade of this Fossies source code misspelling report is really good: "A-"

:laughing: Glad to hear it!

[cpu]

Although after a first review some obviously wrong matches ("False Positives" = FPs) are already filtered out (ignored) please inform me if you find more of them so that I can force a new improved check if applicable.

The findings in the report were all true positives. I've addressed them in https://github.com/letsencrypt/boulder/pull/4634

Two small remarks: I ranked the 5 occurrences of the word "keypair" as FPs but I found also 20 occurrences with the spelling "key pair" (a inconsistency?).

For now I've left the "key pair" vs "keypair" inconsistency unaddressed. I'm not sure if one is better than the other and will see how the other maintainers feel.

The word "ot" in the line 449 of the file cmd/ocsp-updater/main.go is automatically ranked by fossies.org as FP (since containing only two letters) but it seems to be also a real typo.

Good catch! I agree this was a real typo. Also fixed in #4634.

Overall I'm impressed with the codespell results. I think it would be a good idea to integrate this tool into our CI process to catch these typos before they're merged to master. I opened https://github.com/letsencrypt/boulder/issues/4635 to track doing that.

Thanks again for sharing the report,

[cpu]

Overall I'm impressed with the codespell results. I think it would be a good idea to integrate this tool into our CI process to catch these typos before they're merged to master. I opened #4635 to track doing that.

PR is up: https://github.com/letsencrypt/boulder/pull/4637

[jschleus]

I am pleased that the Fossies codespell report was helpful and I'm impressed how quick the codespell tool was integrated into the boulder CI process.

Nevertheless just for completeness also on Fossies a new spelling analysis was done for the corrected current master ("only" in a test folder not really integrated into the general Fossies services and at least principally "forbidden" for search engines):

https://fossies.org/linux/test/boulder-master.5573760.200106.tar.gz/codespell.html

Great, not a single spelling mistake was found, so the Fossies Source code spelling error rating grade is now excellent: "A+"