{"thread":{"id":"52183","subject":"Some misspelling errors in the git release 2.24.0","startedAt":"2019-11-04T15:03:47Z","lastAt":"2019-11-07T09:18:40Z","messageCount":7,"participants":["Fossies Administrator","Elijah Newren"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"385396","messageId":"alpine.LSU.2.21.1911041316270.23271@fossies.org","threadId":"52183","inReplyTo":null,"subject":"Some misspelling errors in the git release 2.24.0","fromName":"Fossies Administrator","fromEmail":"jens.schleusener@fossies.org","sentAt":"2019-11-04T14:55:07Z","receivedAt":"2019-11-04T15:03:47Z","isPatch":false,"sender":{"key":"jens.schleusener@fossies.org","avatar":null},"body":"Hi,\n\nalthough misspelling corrections are not the most exciting issues and the \nspelling errors are rarely true code bugs but mostly contained in the \ncomments and documentation parts they correction may still improve the \noverall quality of a software project a little bit.\n\nIn this sense I created a code misspelling report for \"git\" using the \nprogram \"codespell\"\n\n https://fossies.org/linux/misc/git-2.24.0.tar.xz/codespell.html\n\nor version independent\n\n https://fossies.org/linux/misc/git/codespell.html\n\nThe latter URL redirects always to the report of the last \"git\" release \nsupported on Fossies (if such a report was requested resp. is existing).\n\nPrincipally it's possible to make further runs not only on \"git\" releases \nbut also within a separated test environment on master or branches. If you \nfound FPs please inform me and I will rerun the analysis.\n\nRegards\n\nJens\n\n-- \nFOSSIES - The Fresh Open Source Software archive\nmainly for Internet, Engineering and Science\nhttps://fossies.org/\n"},{"id":"385398","messageId":"CABPp-BFUPhJ1wmJa5htnjXrHkFKLuj2ggAuyPvrM0TP-0TZwuw@mail.gmail.com","threadId":"52183","inReplyTo":"alpine.LSU.2.21.1911041316270.23271@fossies.org","subject":"Re: Some misspelling errors in the git release 2.24.0","fromName":"Elijah Newren","fromEmail":"newren@gmail.com","sentAt":"2019-11-04T15:26:16Z","receivedAt":"2019-11-04T15:26:29Z","isPatch":false,"sender":{"key":"newren@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5455730?v=4"},"body":"On Mon, Nov 4, 2019 at 7:07 AM Fossies Administrator\n wrote:\n>\n> Hi,\n>\n> although misspelling corrections are not the most exciting issues and the\n> spelling errors are rarely true code bugs but mostly contained in the\n> comments and documentation parts they correction may still improve the\n> overall quality of a software project a little bit.\n>\n> In this sense I created a code misspelling report for \"git\" using the\n> program \"codespell\"\n>\n> https://fossies.org/linux/misc/git-2.24.0.tar.xz/codespell.html\n>\n> or version independent\n>\n> https://fossies.org/linux/misc/git/codespell.html\n\nCool, thanks for sending this report along. The typos within the\nDocumentation/ subdirectory have mostly been addressed by the\nen/doc-typofix branch (in next, not yet merged to master). There are\nalso some false positives in this report (e.g. mmaped should not be\nchanged to mapped, CREAT should not be changed to CREATE, examples in\nformat-patch showing how to correct spelling errors need to keep their\nspelling errors or it won't make sense, and perhaps some others), but\nmost of them look like actual spelling errors that should be\ncorrected. I'll send in a patch, and mark you as the reporter of the\nissues.\n\nElijah\n"},{"id":"385401","messageId":"alpine.LSU.2.21.1911041704520.3956@fossies.org","threadId":"52183","inReplyTo":"CABPp-BFUPhJ1wmJa5htnjXrHkFKLuj2ggAuyPvrM0TP-0TZwuw@mail.gmail.com","subject":"Re: Some misspelling errors in the git release 2.24.0","fromName":"Fossies Administrator","fromEmail":"jens.schleusener@fossies.org","sentAt":"2019-11-04T16:14:18Z","receivedAt":"2019-11-04T16:14:31Z","isPatch":false,"sender":{"key":"jens.schleusener@fossies.org","avatar":null},"body":"Hi Elijah,\n\n> On Mon, Nov 4, 2019 at 7:07 AM Fossies Administrator\n> wrote:\n>>\n>> Hi,\n>>\n>> although misspelling corrections are not the most exciting issues and the\n>> spelling errors are rarely true code bugs but mostly contained in the\n>> comments and documentation parts they correction may still improve the\n>> overall quality of a software project a little bit.\n>>\n>> In this sense I created a code misspelling report for \"git\" using the\n>> program \"codespell\"\n>>\n>> https://fossies.org/linux/misc/git-2.24.0.tar.xz/codespell.html\n>>\n>> or version independent\n>>\n>> https://fossies.org/linux/misc/git/codespell.html\n>\n> Cool, thanks for sending this report along. The typos within the\n> Documentation/ subdirectory have mostly been addressed by the\n> en/doc-typofix branch (in next, not yet merged to master). There are\n> also some false positives in this report (e.g. mmaped should not be\n> changed to mapped, CREAT should not be changed to CREATE, examples in\n> format-patch showing how to correct spelling errors need to keep their\n> spelling errors or it won't make sense, and perhaps some others), but\n> most of them look like actual spelling errors that should be\n> corrected. I'll send in a patch, and mark you as the reporter of the\n> issues.\n>\n> Elijah\n\nThanks for your feedback. Yes, the words \"mmaped\" and \"CREAT\" I noticed as \npossible FPs but I was not really sure. And the character of the file \n\"format-patch\" I have simply overseen. So I have done a rerun and the \nmentioned two words and the file are now excluded.\n\nJens\n"},{"id":"385474","messageId":"CABPp-BEzSaf2W+rfUOjEAETK0YFa5-2ZFD0WLV6j-D4LjACjJg@mail.gmail.com","threadId":"52183","inReplyTo":"20191105171107.27379-1-newren@gmail.com","subject":"Re: Some misspelling errors in the git release 2.24.0","fromName":"Elijah Newren","fromEmail":"newren@gmail.com","sentAt":"2019-11-05T18:24:11Z","receivedAt":"2019-11-05T18:24:28Z","isPatch":false,"sender":{"key":"newren@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5455730?v=4"},"body":"On Tue, Nov 5, 2019 at 9:11 AM Elijah Newren wrote:\n> On Mon, Nov 4, 2019 at 8:14 AM Fossies Administrator wrote:\n> > > On Mon, Nov 4, 2019 at 7:07 AM Fossies Administrator\n> > > wrote:\n\n> But I thought it might also be worthwhile to you to report what the\n> false positives found by that program were; I've included them at the\n> end of this email in the form of a patch. The places where the program\n> seemed to struggle were:\n>\n> * In dealing with translation files. It didn't recognize them as\n> such and often tried to translate foreign words to a nearby English\n> one.\n> * In handling variable names: acronyms might be similar to english\n> words (cas, for compare and swap, looks like case), abbreviations\n> might look like alternate words (ans, short for answer, looks like\n> and).\n> * Testcases with intentional spelling errors\n> * Proper names that were similar to English words (Ned -> Need,\n> Claus -> Clause)\n> * miscellaneous tech jargon or package names (e.g. 'filetest' module\n> being replaced with 'file test', 'ith' as in not first or second\n> but the item at position i being replaced with 'with', 'mmaped'\n> being replaced with 'mapped', 'CREAT' changing to 'CREATE',\n> 'UserA' (out of a sequence of UserB, UserC, etc.) changing to\n> 'users', 'spawnve' function name being replaced with \"spawn\",\n> 'CAs' (certificate authorities) being replaced with 'case', etc.)\n\nOoh, one more I remembered that I wanted to point out. It found the\nspelling error 'achiving', but it wanted to replace it with\n'achieving' rather than the correct 'archiving'. Given that the\ncorrect is the same edit distance from the spelling error, it made me\nwonder whether the dictionary in use just needed to be expanded a\nlittle.\n"},{"id":"385581","messageId":"alpine.LSU.2.21.1911061026130.15790@fossies.org","threadId":"52183","inReplyTo":"20191105171107.27379-1-newren@gmail.com","subject":"Re: Some misspelling errors in the git release 2.24.0","fromName":"Fossies Administrator","fromEmail":"jens.schleusener@fossies.org","sentAt":"2019-11-06T11:08:07Z","receivedAt":"2019-11-06T11:09:02Z","isPatch":false,"sender":{"key":"jens.schleusener@fossies.org","avatar":null},"body":"Hi Elijah,\n\n> On Mon, Nov 4, 2019 at 8:14 AM Fossies Administrator wrote:\n>>\n>> Hi Elijah,\n>>\n>>> On Mon, Nov 4, 2019 at 7:07 AM Fossies Administrator\n>>> wrote:\n>>>>\n>>>> Hi,\n>>>>\n>>>> although misspelling corrections are not the most exciting issues and the\n>>>> spelling errors are rarely true code bugs but mostly contained in the\n>>>> comments and documentation parts they correction may still improve the\n>>>> overall quality of a software project a little bit.\n>>>>\n>>>> In this sense I created a code misspelling report for \"git\" using the\n>>>> program \"codespell\"\n>>>>\n>>>> https://fossies.org/linux/misc/git-2.24.0.tar.xz/codespell.html\n>>>>\n>>>> or version independent\n>>>>\n>>>> https://fossies.org/linux/misc/git/codespell.html\n>>>\n>>> Cool, thanks for sending this report along. The typos within the\n>>> Documentation/ subdirectory have mostly been addressed by the\n>>> en/doc-typofix branch (in next, not yet merged to master). There are\n>>> also some false positives in this report (e.g. mmaped should not be\n>>> changed to mapped, CREAT should not be changed to CREATE, examples in\n>>> format-patch showing how to correct spelling errors need to keep their\n>>> spelling errors or it won't make sense, and perhaps some others), but\n>>> most of them look like actual spelling errors that should be\n>>> corrected. I'll send in a patch, and mark you as the reporter of the\n>>> issues.\n>\n> So, I used your codespell program\n\nThat seems to be a misunderstanding: I'm not the author of the codespell \nprogram but I only use that program to detect spelling errors and point to \ntheir existence while offering the option to inspect the context of the \nprobably misspelled words in a fast and comfortable way via a Web page.\n\n> to catch all these and turned\n> en/doc-typofix into a series of patches to fix all the errors:\n> https://public-inbox.org/git/pull.418.v2.git.1572973650.gitgitgadget@gmail.com/\n>\n>\n> But I thought it might also be worthwhile to you to report what the\n> false positives found by that program were; I've included them at the\n> end of this email in the form of a patch. The places where the program\n> seemed to struggle were:\n>\n> * In dealing with translation files. It didn't recognize them as\n> such and often tried to translate foreign words to a nearby English\n> one.\n> * In handling variable names: acronyms might be similar to english\n> words (cas, for compare and swap, looks like case), abbreviations\n> might look like alternate words (ans, short for answer, looks like\n> and).\n> * Testcases with intentional spelling errors\n> * Proper names that were similar to English words (Ned -> Need,\n> Claus -> Clause)\n> * miscellaneous tech jargon or package names (e.g. 'filetest' module\n> being replaced with 'file test', 'ith' as in not first or second\n> but the item at position i being replaced with 'with', 'mmaped'\n> being replaced with 'mapped', 'CREAT' changing to 'CREATE',\n> 'UserA' (out of a sequence of UserB, UserC, etc.) changing to\n> 'users', 'spawnve' function name being replaced with \"spawn\",\n> 'CAs' (certificate authorities) being replaced with 'case', etc.)\n\nThanks for the detailed and informed feedback. These are exactly problems \nthat I noticed as well. Some additional ones are for e.g. words at the end \nof a string definition (apostrophe), mail addresses and differences \nbetween US-English and UK-English. Sometimes it's difficult to decide what \nto exclude: For e.g. your mentioned word \"ans\" is often intentionally used \nbut often it's also a typo (\"and\") so FPs or FNs seem unavoidable. So \ncodespell respectively Fossies can give only the pointers and an \nindividual check seems always required.\n\nSome of the according FPs are excluded by Fossies generally, some other \nobvious FPs are excluded by Fossies specifically for each FOSS project \n(see always the bold item \"Codespell configuration\" with a link to \n\"Project-specific additions\" or to \"(no project-specific adaptions yet \ndone)\" that shows all the excluded words and directories/files).\n\n> Some of these would be difficult for any tool to deal with, but e.g.\n> recognizing translation files as such and ignoring them might be\n> interesting.\n\nAs one can see on the page\n\n https://fossies.org/linux/misc/git-2.24.0.tar.xz/codespell_conf_info.html\n\nthere are already done some according attempts.\n\nTo let run codespell with an English dictionary about directories like \n\"translations\" or \"langmap\" is probably in the most cases meaningless \n(although in such directories may be contained also \"English\" source \ncode). So if one uses codespell manually one should use options like \n\"--ignore-words-list\" and \"--skip\" (directories, files) and can look \noptionally for a starting point to the values Fossies has used.\n\n> Anyway, thanks for the report and the pointer to the tool.\n\nAlthough (hopefully) most of the FPs within your list are already excluded \nby Fossies I will check the list to make Fossies perhaps even smarter.\n\n> -- 8< --\n> Subject: [PATCH] DO NOT MERGE: False positives from `codespell -w`\n\n[... the very big list of FPs removed in this reply mail ...]\n\nRegards\n\nJens\n\n-- \nFOSSIES - The Fresh Open Source Software archive\nmainly for Internet, Engineering and Science\nhttps://fossies.org/\n"},{"id":"385651","messageId":"CABPp-BH=XxwJod8XpXYzpmXuo2-8LBozQGH4eEps_r4C798+ag@mail.gmail.com","threadId":"52183","inReplyTo":"alpine.LSU.2.21.1911061026130.15790@fossies.org","subject":"Re: Some misspelling errors in the git release 2.24.0","fromName":"Elijah Newren","fromEmail":"newren@gmail.com","sentAt":"2019-11-07T04:46:09Z","receivedAt":"2019-11-07T04:46:22Z","isPatch":false,"sender":{"key":"newren@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5455730?v=4"},"body":"On Wed, Nov 6, 2019 at 3:08 AM Fossies Administrator\n wrote:\n>\n> Hi Elijah,\n>\n> > On Mon, Nov 4, 2019 at 8:14 AM Fossies Administrator wrote:\n> >>\n> >> Hi Elijah,\n> >>\n> >>> On Mon, Nov 4, 2019 at 7:07 AM Fossies Administrator\n> >>> wrote:\n\n> > So, I used your codespell program\n>\n> That seems to be a misunderstanding: I'm not the author of the codespell\n> program but I only use that program to detect spelling errors and point to\n> their existence while offering the option to inspect the context of the\n> probably misspelled words in a fast and comfortable way via a Web page.\n\nOops, sorry for the misunderstanding; thanks for clearing it up.\n\n[...]\n> Some of the according FPs are excluded by Fossies generally, some other\n> obvious FPs are excluded by Fossies specifically for each FOSS project\n> (see always the bold item \"Codespell configuration\" with a link to\n> \"Project-specific additions\" or to \"(no project-specific adaptions yet\n> done)\" that shows all the excluded words and directories/files).\n[...]\n> As one can see on the page\n>\n> https://fossies.org/linux/misc/git-2.24.0.tar.xz/codespell_conf_info.html\n>\n> there are already done some according attempts.\n\nAh, thanks for the pointer. Could you add t/t9150/svk-merge.dump and\nt/t9151/svn-mergeinfo.dump the the list of files to exclude? Both\nhave the 'hapenning' typo, but both are a dump of some repository and\nediting it means recomputing sha1sums and whatnot for tests that just\nisn't worth it. I thought maybe I could get away with correcting\nthose spelling errors but backed out once I saw further knock-on\neffects.\n\nThanks for the report and the background and corrections!\n\nElijah\n"},{"id":"385687","messageId":"alpine.LSU.2.21.1911071007260.10631@fossies.org","threadId":"52183","inReplyTo":"CABPp-BH=XxwJod8XpXYzpmXuo2-8LBozQGH4eEps_r4C798+ag@mail.gmail.com","subject":"Re: Some misspelling errors in the git release 2.24.0","fromName":"Fossies Administrator","fromEmail":"jens.schleusener@fossies.org","sentAt":"2019-11-07T09:18:26Z","receivedAt":"2019-11-07T09:18:40Z","isPatch":false,"sender":{"key":"jens.schleusener@fossies.org","avatar":null},"body":"Hi Elijah,\n\nOn Wed, 6 Nov 2019, Elijah Newren wrote:\n\n> On Wed, Nov 6, 2019 at 3:08 AM Fossies Administrator\n> wrote:\n>>\n>> Hi Elijah,\n>>\n>>> On Mon, Nov 4, 2019 at 8:14 AM Fossies Administrator wrote:\n>>>>\n>>>> Hi Elijah,\n>>>>\n>>>>> On Mon, Nov 4, 2019 at 7:07 AM Fossies Administrator\n>>>>> wrote:\n>\n>>> So, I used your codespell program\n>>\n>> That seems to be a misunderstanding: I'm not the author of the codespell\n>> program but I only use that program to detect spelling errors and point to\n>> their existence while offering the option to inspect the context of the\n>> probably misspelled words in a fast and comfortable way via a Web page.\n>\n> Oops, sorry for the misunderstanding; thanks for clearing it up.\n>\n> [...]\n>> Some of the according FPs are excluded by Fossies generally, some other\n>> obvious FPs are excluded by Fossies specifically for each FOSS project\n>> (see always the bold item \"Codespell configuration\" with a link to\n>> \"Project-specific additions\" or to \"(no project-specific adaptions yet\n>> done)\" that shows all the excluded words and directories/files).\n> [...]\n>> As one can see on the page\n>>\n>> https://fossies.org/linux/misc/git-2.24.0.tar.xz/codespell_conf_info.html\n>>\n>> there are already done some according attempts.\n>\n> Ah, thanks for the pointer. Could you add t/t9150/svk-merge.dump and\n> t/t9151/svn-mergeinfo.dump the the list of files to exclude? Both\n> have the 'hapenning' typo, but both are a dump of some repository and\n> editing it means recomputing sha1sums and whatnot for tests that just\n> isn't worth it.\n\nSure, done.\n\nPrincipally test directories and files seem to be a \"special\" area\nalso for spelling checks.\n\n> I thought maybe I could get away with correcting\n> those spelling errors but backed out once I saw further knock-on\n> effects.\n\nThat is one reason that only the developers should made such corrections.\n\n> Thanks for the report and the background and corrections!\n\nRegards\n\nJens\n\n-- \nFOSSIES - The Fresh Open Source Software archive\nmainly for Internet, Engineering and Science\nhttps://fossies.org/\n"}]}