Bug 925

Summary:	Codespell report for "Sudo" (on fossies.org)
Product:	Sudo	Reporter:	Jens Schleusener <jens.schleusener>
Component:	Sudo	Assignee:	Todd C. Miller <Todd.Miller>
Status:	RESOLVED FIXED
Severity:	low
Priority:	low
Version:	1.9.0
Hardware:	All
OS:	All

Description Jens Schleusener 2020-05-06 08:04:12 MDT

The FOSS server fossies.org - also supporting the "Sudo" software - offers a feature "Source code misspelling reports":

  https://fossies.org/features.html#codespell

Such reports are normally only generated on request, but as Fossies administrator I have just created an analysis for the latest "Sudo" release candidate 1.9.0rc3:

  https://fossies.org/linux/misc/sudo-1.9.0rc3.tar.gz/codespell.html

Hint: That URL is only valid til a new Sudo version is released.

Although after a first review some obviously wrong matches ("false positives") 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. So for e.g. also the many entries in the ChangeLog file (that may not be correctable or for which the correction effort seems too high) could be excluded.

Just for information there are also two supplemental pages https://fossies.org/linux/misc/sudo-1.9.0rc3.tar.gz/codespell_conf.html showing some used "codespell" configurations and https://fossies.org/linux/misc/sudo-1.9.0rc3.tar.gz/codespell_fps.html showing all resulting obvious "false positives".

By the way, the context type of the spelling errors and typos are marked by a single character (within the sortable column "T"): The less interesting, probably not user visible ones (in "comments") are greyed, while the probably more interesting ones are black-colored.

Although only "unspectacular" spelling errors or typos were found and many of them just in comments (so not visible to normal users), I hope that the report can nevertheless be a little bit helpful.

Comment 1 Todd C. Miller 2020-05-06 08:54:27 MDT

Thanks.  It would be helpful to omit the ChanngeLog file from the spell check since it is automatically generated from the commit log.

Comment 2 Todd C. Miller 2020-05-06 09:28:26 MDT

Thanks, I believe I've fixed all the non-Changelog ones in https://www.sudo.ws/repos/sudo/rev/1fb13dc3991b

Comment 3 Jens Schleusener 2020-05-06 10:54:08 MDT

1) Ok, ChangeLog is now ignored (excluded).

2) Great, the patch is nearly perfect (only the replacement of "beggining" by "begining" in the file src/sesh.c seems only "half-hearted" -> "beginning").

Comment 4 Todd C. Miller 2020-05-06 11:05:05 MDT

Whoops, fixed.

Comment 5 Jens Schleusener 2020-05-06 13:18:33 MDT

Just for completeness there will be a report generated for optional further 1.9.0 release candidates and for the 1.9.0 release itself. The latter will be accessible also under the version independent URL

  https://fossies.org/linux/misc/sudo/codespell.html

that should redirect always to the report for the latest Sudo release (if available).

Comment 6 Jens Schleusener 2020-05-07 01:39:42 MDT

Perfect (naturally besides of some possibly by codespell undetected errors):

 https://fossies.org/linux/misc/sudo-1.9.0rc4.tar.gz/codespell.html

By the way, the corrected errors can be found under the link "History" in the "Codespell report:" line.

Comment 7 Jens Schleusener 2020-05-12 10:11:45 MDT

Ok, also the new Sudo release 1.9.0 looks perfect.

By the way, the additional typos you detected in the file configure.ac was caused by a Fossies bug since that project specific file has slipped accidentally into the list of ignored "autotools" files (now fixed).

A nice idea is the optional codespell usage integrated into the Makefile.