Skip to content

Commit

Permalink
Clarify helpful commands
Browse files Browse the repository at this point in the history 
Based on the MIR team discussion and PR feedback clarify that this
needs to be run in source and even more on built binaries.
Further clarify how to look for setuid and setgid.
And finally, those are not rules or content to leave in the final
post, so these hints are now prefixed with RULE as we usually do
for this kind of content.

Signed-off-by: Christian Ehrhardt <[email protected]>
  • Loading branch information
@cpaelzer
cpaelzer committed Jul 19, 2023
1 parent 5c41910 commit d39c10d
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -873,9 +873,12 @@ TODO-B: - no incautious use of malloc/sprintf (the language has no direct MM)
TODO: - no use of sudo, gksu, pkexec, or LD_LIBRARY_PATH (usage is OK inside
TODO: tests)
TODO: - no use of user nobody
TODO: (consider at least `grep` for it and `find . -user nobody`)
TODO: - no use of setuid
TODO: (consider at least `grep` for it and `find . -perm -4000`)
RULE: (consider at least `grep -Hrn nobody` for it

Check failure on line 876 in README.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`Hrn` is not a recognized word. (unrecognized-spelling)
RULE: and run `find . -user nobody` in source and built binaries)
TODO: - no use of setuid / setgid

Check failure on line 878 in README.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`setgid` is not a recognized word. (unrecognized-spelling)
RULE: (consider at least `grep -Hrn -e setuid -e setgid` for it

Check failure on line 879 in README.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`Hrn` is not a recognized word. (unrecognized-spelling)

Check failure on line 879 in README.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`setgid` is not a recognized word. (unrecognized-spelling)
RULE: and run `find . \( -perm -4000 -o -perm -2000 \)` in source and
RULE: built binaries)
TODO: - use of setuid, but ok because TBD (prefer systemd to set those
TODO: for services)
TODO: - no important open bugs (crashers, etc) in Debian or Ubuntu
Expand Down

1 comment on commit d39c10d

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log for details.

Unrecognized words (2)

Hrn
setgid

To accept ✔️ these unrecognized words as correct, run the following commands

... in a clone of the [email protected]:cpaelzer/ubuntu-mir.git repository
on the add-commands branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/cpaelzer/ubuntu-mir/actions/runs/5597295915/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary

This includes both expected items (10) from .github/actions/spelling/expect.txt and unrecognized words (2)

Dictionary Entries Covers
cspell:cpp/src/cpp.txt 30216 4
cspell:win32/src/win32.txt 53509 2
cspell:php/php.txt 2597 2
cspell:cpp/src/stdlib-c.txt 290 2
cspell:ruby/ruby.txt 278 1
cspell:r/src/r.txt 808 1
cspell:python/src/python/python-lib.txt 3873 1
cspell:node/src/node-old.txt 730 1
cspell:node/node.txt 1768 1
cspell:fullstack/fullstack.txt 390 1

Consider adding them using (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/cpp.txt
          cspell:win32/src/win32.txt
          cspell:php/php.txt
          cspell:cpp/src/stdlib-c.txt
          cspell:ruby/ruby.txt
          cspell:r/src/r.txt
          cspell:python/src/python/python-lib.txt
          cspell:node/src/node-old.txt
          cspell:node/node.txt
          cspell:fullstack/fullstack.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
✏️ Contributor please read this By default the suggested command will add the listed items to the .github/actions/spelling/expect.txt. This is not always desired!

If a listed items is

  • ... misspelled, then please correct them instead of changing the spell checker configuration.
  • ... an actual word/term that has a high probability of showing up in future contributions, please add it to .github/actions/spelling/allow.
  • ... an term/word that just you use or shouldn't generally be accepted, please add it to .github/actions/spelling/expect.txt.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push – it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

Please sign in to comment.