patchlwIP - A Lightweight TCP/IP stack - Patches: patch #9883, Fix typos using codespell

 
 

You are not allowed to post comments on this tracker with your current authentication level.

patch #9883: Fix typos using codespell

Submitter:  Jonathan D <jona>
Submitted:  Mon 06 Jan 2020 11:21:59 PM UTC
   
 
Category:  None Priority:  3 - Low
Status:  Done Privacy:  Public
Assigned to:  goldsimon Open/Closed:  Closed
Planned Release:  None

Jump to the original submission

Sat 15 Feb 2020 08:56:49 PM UTC, comment #6: 

Applied, thanks for the patches.

I've added the possibility to call the script with "-w" to write back changed files to disk so the changes can be viewed with "git diff" and applied -> found more fixes that way.

Simon Goldschmidt <goldsimon>
Group administrator
Wed 12 Feb 2020 11:22:55 PM UTC, comment #5: 

You are right, codespell can automatically fix the errors. However, the automatic fixing of errors should be executed with the greatest care. I would recommend a human check somewhere in the process.

Jonathan D <jona>
Mon 10 Feb 2020 09:02:36 PM UTC, comment #4: 

Yes. I just tested check.sh. I was under the impression that codespell could automatically fix the errors it finds, am I wrong there?

Simon Goldschmidt <goldsimon>
Group administrator
Sat 08 Feb 2020 04:01:29 PM UTC, comment #3: 

Hello,

Any update ?

Thank you

Jonathan D <jona>
Mon 13 Jan 2020 10:41:21 PM UTC, comment #2: 

Here is another review of the idea.

First patch "Add codespell wrappers ..." are the two scripts you asked.
Second patch "Fix typos ..." is an updated version considering your remarks (sorry for the Makefile, it was a little bit late).

If you want a fast check, you can try with : "codespell -q 2 --ignore-words-list=nd,ans,tolen,ofo,wan -i1 $(git ls-tree -r --full-tree --name-only HEAD | grep -E '\.([CcHh])$')" (-i1 discard multiple choices)
or
"codespell -q 2 --ignore-words-list=nd,ans,tolen,ofo,wan,mut -i3 $(git ls-tree -r --full-tree --name-only HEAD | grep -E '\.([CcHh])$')" (it ask for input over multiple choices)
The two scripts here are dry-run version (-w to write to files).

(file #48225, file #48226)

Jonathan D <jona>
Thu 09 Jan 2020 08:59:58 PM UTC, comment #1: 

Nice patch. However:
- MIBs are imported documents, we cannot just change them
- unix example_app Makefile is completely changed

Instead of applying this patch, I would rather commit a "check.sh" script doing everything right and then just committing its changes.

Is this patch an output of such a script? If so, could you post it here?

Simon Goldschmidt <goldsimon>
Group administrator
Mon 06 Jan 2020 11:21:59 PM UTC, original submission:  

The next step to avoid typo can be to provide a script like for RIOT: https://github.com/RIOT-OS/RIOT/blob/master/dist/tools/codespell/check.sh

Jonathan D <jona>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by goldsimon (Posted a comment)
  • -email is unavailable- added by jona (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 6 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-02-15 goldsimon StatusNone Done
        Assigned toNone goldsimon
        Open/ClosedOpen Closed
    2020-01-13 jona Attached File- Added 0001-Add-codespell-wrappers-check.sh-changed_files.sh.patch, #48225
        Attached File- Added 0001-Fix-typos-using-codespell.patch, #48226
    2020-01-06 jona Attached File- Added 0001-Fix-typos-using-codespell.patch, #48174

    Back to the top

    Powered by Savane 3.13-3230.
    Corresponding source code