php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Bug #78880 Spelling error report
Submitted: 2019-11-28 16:36 UTC Modified: 2019-12-22 18:36 UTC
From: admin at fossies dot org Assigned: cmb (profile)
Status: Closed Package: *General Issues
PHP Version: master OS:
Private report: No CVE-ID: None
View Add Comment Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
You can add a comment by following this link or if you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: admin at fossies dot org
New email:
PHP Version: OS:

 

 [2019-11-28 16:36 UTC] admin at fossies dot org
Description:
------------
The FOSS server fossies.org offers a new feature "Source code misspelling reports":

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

Although such reports are normally generated only on request as Fossies admin I have just forced an analysis for the new PHP release 7.4.0:

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

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

 https://fossies.org/linux/www/php-7.4.0.tar.xz/codespell.html

Although already some obviously wrong matches (false positives) are prefiltered (ignored) please inform me if you find more of them so that I can force a new improved check.



Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2019-11-29 12:38 UTC] cmb@php.net
-Status: Open +Status: Feedback -Assigned To: +Assigned To: cmb
 [2019-11-29 12:38 UTC] cmb@php.net
Thanks for the report, but in my opinion, fixing spelling mistakes
in comments and error message for a stable version shouldn't be
done on such a large scale (if at all), because that may break
tests and other code relying on these spelling mistakes.

I think it would be worthwhile fixing this in master, so it would
be more useful if you could test that branch.
 [2019-11-29 17:26 UTC] admin at fossies dot org
-Status: Feedback +Status: Assigned
 [2019-11-29 17:26 UTC] admin at fossies dot org
That's seems reasonable. So here the new report

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

that redirects currently to 

 https://fossies.org/linux/test/php-src-master-f8f48ce.191129.tar.gz/codespell.html

Also I removed some more obvious False Positives (a.o. machanism, crypted, aline, childs, trys).
Unfortunately I'm not familiar with PHP itself so my valuations may not always be correct.
So it may also meaningful for the experts to look at the supplemental pages

 https://fossies.org/linux/test/php-src-master.tar.gz/codespell_conf.html

showing some used codesspell configurations and

  https://fossies.org/linux/test/php-src-master.tar.gz/codespell_fps.html

showing all resulting False Positives.
 [2019-12-02 16:31 UTC] cmb@php.net
-Status: Assigned +Status: Verified -PHP Version: 7.4.0 +PHP Version: master
 [2019-12-02 16:31 UTC] cmb@php.net
Thanks for checking master!  I think at least some of these typos
should be addressed; I'll do so as soon as possible.
 [2019-12-21 11:09 UTC] cmb@php.net
Automatic comment on behalf of cmbecker69@gmx.de
Revision: http://git.php.net/?p=php-src.git;a=commit;h=dabc28d18245086a68c88d50dfba380ebd60a236
Log: Fix #78880: Spelling error report
 [2019-12-21 11:09 UTC] cmb@php.net
-Status: Verified +Status: Closed
 [2019-12-21 11:10 UTC] cmb@php.net
Thanks again for having created the codespell report and for
having opened this bug ticket!  Overall, I think it is a useful
tool, although fixing every single spelling mistake is a lot of
effort which can be spend more reasonably on other tasks.  Still I
fixed a lot of mistakes, and the spelling mistake count may now
roughly be halfed.

I didn't notice any real false positives reported by codespell,
but for instance, `Produkt` must not be fixed for the reported
cases, because it's used to test a German translation.  Also,
words like `alloced` and `dereferencable` don't appear to be
outright wrong (at least the former seems not uncommon in
programmer jargon).

Finally, there have been some correctly indentified spelling
mistakes regarding some of our bundled libraries (e.g. libpcre2,
libgd, timelib). Fixing these in the bundled libraries doesn't
make sense, since the mistakes would be reintroduced which every
update.  Instead it might be sensible to report these spelling
mistakes upstream.
 [2019-12-22 18:36 UTC] admin at fossies dot org
I agree that fixing code mistakes is more important than fixing spelling mistakes.

The word `Produkt` is now ignored. The word `alloced` was already marked by Fossies as "Sloppy short computer slang" but is now also generally ignored. The word `dereferencable` seems to be a real misspelling but is now marked as "Common misspelling in programmer jargon".

Problematic for me as PHP-layman is the decision which directories are to be ignored. After your remark I tried firstly to ignore the "ext"-subdirectory completely assuming the name means "external" but looking deeper in the according files I found mostly a PHP copyright. So it means probably rather "extension" and I searched til depth 2 for subdirectories without a PHP copyright ending with

 date/lib
 fileinfo/libmagic
 intl/collator
 intl/common
 intl/converter
 intl/dateformat
 intl/formatter
 intl/grapheme
 intl/locale
 intl/msgformat
 intl/normalizer
 intl/resourcebundle
 intl/spoofchecker
 intl/transliterator
 intl/uchar
 pcre/pcre2lib

Since your mentioned bundled libraries seems included in the above list that directories are now also ignored (excluded).

Here the spelling error results with the old and the new codespell configuration:

             spelling error   false positives
 PHP      occurrences types occurrences types
 7.4.1           1473   308        1873   104  ("old" config)
                 1385   271        1771    97  ("new" config)
 f8f48ce.191129  1247   313        1914   107  ("old" config)
                 1157   276        1812   101  ("new" config)
 dabc28d.191221   520   296        1914   107  ("old" config)
                  432   259        1812   101  ("new" config)

Here for completeness the current Fossies codespell report URLs:

 https://fossies.org/linux/www/php/codespell.html
(https://fossies.org/linux/www/php-7.4.1.tar.xz/codespell.html) 

 https://fossies.org/linux/test/php-src-master.tar.gz/codespell.html
(https://fossies.org/linux/test/php-src-master-dabc28d.191221.tar.gz/codespell.html)
(https://fossies.org/linux/test/php-src-master-f8f48ce.191129.tar.gz/codespell_fps.html)
 [2020-01-16 09:04 UTC] kocsismate@php.net
Automatic comment on behalf of kocsismate@woohoolabs.com
Revision: http://git.php.net/?p=php-src.git;a=commit;h=0b4778c377a5753a0deb9cfc697d4f62acf93a29
Log: Fix #78880: Another bunch of spelling errors
 [2020-01-16 11:21 UTC] kocsismate@php.net
I continued what Christopher started, and fixed a lot of other spelling mistakes for the master branch. I think we are done for now. :)
 [2020-01-16 11:21 UTC] kocsismate@php.net
Automatic comment on behalf of kocsismate@woohoolabs.com
Revision: http://git.php.net/?p=php-src.git;a=commit;h=c3cf01b553b1a358531d0fa56e3caba51f9a3e33
Log: Fix #78880: Yet another batch of spelling errors
 [2020-01-16 13:07 UTC] admin at fossies dot org
Great, looks much better.

Here the current spelling error results

             spelling error   false positives
 PHP      occurrences types occurrences types
 c3cf01b.200116   232   149        1831   107  ("new" config)

and the according Fossies codespell report URLs

 https://fossies.org/linux/test/php-src-master.tar.gz/codespell.html
(https://fossies.org/linux/test/php-src-master.c3cf01b.200116.tar.gz/codespell.html)
(https://fossies.org/linux/test/php-src-master.c3cf01b.200116.tar.gz/codespell_fps.html)

Jens
 [2020-01-16 13:47 UTC] kocsismate@php.net
I was very curious about the results, so thank you very much for the quick regeneration! It's really tempting to continue just a little bit more...
 [2020-01-16 18:30 UTC] kocsismate@php.net
Automatic comment on behalf of kocsismate@woohoolabs.com
Revision: http://git.php.net/?p=php-src.git;a=commit;h=afdaa91170a1f7b0387cf577d957d4d6c015c136
Log: Fix #78880: Final spelling fixes
 [2020-01-18 19:18 UTC] kocsismate@php.net
Jens,

If it's not a big ask, could you please regenerate the report for a very last time? I would be curious to see the fruit of our work. :)
 [2020-01-18 19:51 UTC] admin at fossies dot org
It looks even better.

If it would be helpful, don't hesitate to request new checks!

Here the current spelling error results

             spelling error   false positives
 PHP      occurrences types occurrences types
 3c72105.200118   120    87        1827   107  ("new" config)

and the according Fossies codespell report URLs

 https://fossies.org/linux/test/php-src-master.tar.gz/codespell.html
(https://fossies.org/linux/test/php-src-master.3c72105.200118.tar.gz/codespell.html)
(https://fossies.org/linux/test/php-src-master.3c72105.200118.tar.gz/codespell_fps.html)
 [2020-01-19 17:29 UTC] kocsismate@php.net
Automatic comment on behalf of kocsismate@woohoolabs.com
Revision: http://git.php.net/?p=php-src.git;a=commit;h=99db00b1f2c6338041bbe3db8b6d0eaee5cd8c94
Log: Fix #78880 Another round
 
PHP Copyright © 2001-2020 The PHP Group
All rights reserved.
Last updated: Mon Jan 27 21:01:23 2020 UTC