Skip Menu |
 

Date: Thu, 26 Mar 2020 10:26:35 +0100 (CET)
From: "Fossies Administrator" <Jens.Schleusener@fossies.org>
To: krb5-bugs@mit.edu
Subject: Codespell report for "krb5" (on fossies.org)
Download (untitled) / with headers
text/plain 1.4KiB
Hi,

the FOSS server fossies.org - also supporting "Kerberos" - offers a new
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 (for testing purposes) an analysis for
the current "krb5" release 1.18:

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

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

https://fossies.org/linux/misc/krb5-1.18.tar.gz/codespell.html

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.

Just for information there are also two supplemental pages

https://fossies.org/linux/misc/krb5/codespell_conf.html

showing some used "codespell" configurations and

https://fossies.org/linux/misc/krb5/codespell_fps.html

showing all resulting obvious "false positives".

If appropriate, additional reports for the current or future development
versions could be created (but the latter in a special "test" folder that
isn't integrated in the Fossies standard services and should not be
accessible by search engines).

Regards

Jens

--
FOSSIES - The Fresh Open Source Software archive
mainly for Internet, Engineering and Science
https://fossies.org/
On Thu Mar 26 11:40:12 2020, Jens.Schleusener@fossies.org wrote:
Show quoted text
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.
I found two false positives, although neither of them seems easy to filter for:

* "Sorce" in README is a person's last name, not a typo for "Source".
* "thur" in getdate.y is an abbreviation for "thursday", not a typo for "their".

This may be an unusual property of the MIT krb5 project, but we ship a bunch of generated documentation in release tarballs that isn't checked into the repository.  Many of the earlier results in the report are from the generated documentation, either mirroring a typo from elsewhere in the source code or simply reflecting a typo in some upstream material included by documentation tooling.
 
To: "Greg Hudson via RT" <rt@krbdev.mit.edu>
Subject: Re: [krbdev.mit.edu #8891] Codespell report for "krb5" (on fossies.org)
From: "Fossies Administrator" <Jens.Schleusener@fossies.org>
Date: Tue, 31 Mar 2020 10:36:26 +0200 (CEST)
Download (untitled) / with headers
text/plain 1.6KiB
Hi Greg,

Show quoted text
> On Thu Mar 26 11:40:12 2020, Jens.Schleusener@fossies.org wrote:
>
> 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.
>
> I found two false positives, although neither of them seems easy to filter for:
>
> * "Sorce" in README is a person's last name, not a typo for "Source".
> * "thur" in getdate.y is an abbreviation for "thursday", not a typo for
> "their".

Oops, that are two false positives that I try to avoid but ...

Now corrected.

Show quoted text
> This may be an unusual property of the MIT krb5 project, but we ship a bunch of
> generated documentation in release tarballs that isn't checked into the
> repository. Many of the earlier results in the report are from the generated
> documentation, either mirroring a typo from elsewhere in the source code or
> simply reflecting a typo in some upstream material included by documentation
> tooling.

Yes, that is a general problem. If clearly to see I try to exclude such
"external" or "third-party" sub-directories but often it's not so easy to
decide. At least I exclude now "src/lib/crypto/builtin/aes/" although I
have the impression that there are more directories to be excluded.

There are no "spectacular" errors and many of the found errors are "only"
in comments and not "user visible". So ignore the irrelevant errors and
take the report just as an information.

If at any time there is an interest to analyse a repository code so let it
know me.

Regards

Jens

--
FOSSIES - The Fresh Open Source Software archive
mainly for Internet, Engineering and Science
https://fossies.org/
From: ghudson@mit.edu
Subject: git commit

Fix typos in documentation

Correct documentation spelling errors detected using codespell.
Reported by Jens Schleusener.

https://github.com/krb5/krb5/commit/022f2cbc7f5abc9fbefa0d68b6025216c1b59353
Author: Greg Hudson <ghudson@mit.edu>
Commit: 022f2cbc7f5abc9fbefa0d68b6025216c1b59353
Branch: master
doc/admin/conf_files/krb5_conf.rst | 2 +-
doc/admin/host_config.rst | 2 +-
doc/admin/pkinit.rst | 2 +-
doc/iprop-notes.txt | 2 +-
doc/kadm5/adb-unit-test.tex | 2 +-
doc/kadm5/api-funcspec.tex | 14 +++++++-------
doc/kadm5/api-server-design.tex | 16 ++++++++--------
doc/kadm5/api-unit-test.tex | 30 +++++++++++++++---------------
doc/mitK5features.rst | 2 +-
doc/rpc/design.tex | 14 +++++++-------
src/include/krb5/krb5.hin | 8 ++++----
11 files changed, 47 insertions(+), 47 deletions(-)
CC: Jens.Schleusener@fossies.org
Subject: Re: [krbdev.mit.edu #8891] Resolved: Codespell report for "krb5" (on fossies.org)
Date: Wed, 8 Apr 2020 21:56:27 +0200 (CEST)
From: "Fossies Administrator" <Jens.Schleusener@fossies.org>
To: "Greg Hudson via RT" <rt@krbdev.mit.edu>
Hi Greg,

Show quoted text
> According to our records, your request has been resolved. If you have any
> further questions or concerns, please respond to this message.

Just as supplement I have generated a codespell report for the latest
master version "db245c0" in a special Fossies folder named "/linux/test"
that isn't integrated into the Fossies services and should also not be
accessible for search engines:

https://fossies.org/linux/test/krb5-master.db245c0.200408.tar.gz/codespell.html

Great, that looks much better.

The still shown spelling errors may be "acceptable spelling alternatives",
errors contained in external code or perhaps in some few cases overseen
errors.

Regards

Jens

--
FOSSIES - The Fresh Open Source Software archive
mainly for Internet, Engineering and Science
https://fossies.org/
From: ghudson@mit.edu
Subject: git commit

Fix typos in documentation

Correct documentation spelling errors detected using codespell.
Reported by Jens Schleusener.

(cherry picked from commit 022f2cbc7f5abc9fbefa0d68b6025216c1b59353)

https://github.com/krb5/krb5/commit/b821301f3ce69bae299f77835b3f5e712035d3a3
Author: Greg Hudson <ghudson@mit.edu>
Commit: b821301f3ce69bae299f77835b3f5e712035d3a3
Branch: krb5-1.18
doc/admin/conf_files/krb5_conf.rst | 2 +-
doc/admin/host_config.rst | 2 +-
doc/admin/pkinit.rst | 2 +-
doc/iprop-notes.txt | 2 +-
doc/kadm5/adb-unit-test.tex | 2 +-
doc/kadm5/api-funcspec.tex | 14 +++++++-------
doc/kadm5/api-server-design.tex | 16 ++++++++--------
doc/kadm5/api-unit-test.tex | 30 +++++++++++++++---------------
doc/mitK5features.rst | 2 +-
doc/rpc/design.tex | 14 +++++++-------
src/include/krb5/krb5.hin | 8 ++++----
11 files changed, 47 insertions(+), 47 deletions(-)