openSUSE / zypper

World's most powerful command line package manager
http://en.opensuse.org/Portal:Zypper
Other
409 stars 111 forks source link

Codespell report for "zypper" (on fossies.org) #412

Open jschleus opened 3 years ago

jschleus commented 3 years ago

A bit nitpicky (especially since most of the found misspellings are only in code comments and thus not visible or relevant to users).

The FOSS server fossies.org offers among others a feature named "Source code misspelling reports". Such reports are normally only generated on request, but as Fossies administrator I have created for testing purposes such a codespell based analysis for the GitHub "master" branch of "zypper". That continuously updated report is generated within a special restricted "test" folder that isn't really integrated into the standard Fossies services and should also not be accessible to search engines:

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

That version independent URL hopefully always redirects to the report for the latest "master" version identified by the short GitHub commit ID and a year-month-day string (YYMMDD) representing the according git pull date (mostly = commit date). The refresh rate is currently half-hourly.

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. If JavaScript is enabled all table columns are sortable.

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 three supplemental pages showing some used "codespell" configuration details, all obvious false positives and an misspelling history (log).

OK, spelling corrections certainly have a low priority, but they may also contribute to the overall quality of a software project. So I hope that the report can nevertheless be a little bit useful.

By the way, a similar issue report will be created for the related project "libzypp".

Off topic: While planning a zypper upgrade I found in the Internet an according HOWTO that recommends the use of the option --download-in-advance. But in the man page that option is already described as "This is the default" but the excluding option --download-in-heaps is also described as "This is the default mode". Irritating at least to me, so a personal misunderstanding or a documentation error? Since disk space is enough available it seems --download-in-advance would be the preferred option to avoid a possible broken state.