10000 Some docs issues · Issue #5692 · uutils/coreutils · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Some docs issues #5692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
15 of 17 tasks
tertsdiepraam opened this issue Dec 22, 2023 · 12 comments
Open
15 of 17 tasks

Some docs issues #5692

tertsdiepraam opened this issue Dec 22, 2023 · 12 comments
Labels
good first issue For newcomers!

Comments

@tertsdiepraam
Copy link
Member
tertsdiepraam commented Dec 22, 2023 •
edited
Loading

I'm going through all signatures for the argument parser. I found some issues in the docs:

  • join should be join [OPTION]... FILE1 FILE2
  • cut should be cut OPTION... [FILE]...
  • mkdir should be mkdir [OPTION]... DIRECTORY... (for some reason it says [USER] now 😄 )
  • The usage string for everything based on hashsum are missing.
  • more now says more [OPTIONS] <FILE>... which matches util-linux but uses a different syntax than GNU, which would be more [OPTIONS]... FILE...
  • nohup FLAG should be nohup OPTION
  • pr should be pr [OPTION]... [FILE]...
  • printenv should be printenv [OPTION]... [VARIABLE]...
  • printf should have the strings printf FORMAT [ARGUMENT]... and printf OPTION
  • basenc has a " at the end of the usage string that shouldn't be there.
  • runcon has "; at the end of the usage string that shouldn't be there.
  • shuf has ; at the end of the usage string that shouldn't be there.
  • sum has " at the end of the usage string that shouldn't be there.
  • The last three lines of test's usage string should be written with [ instead of test.
  • uniq should be uniq [OPTION]... [INPUT [OUTPUT]]
  • unlink should be unlink FILE and unlink OPTION
  • vdir is missing documentation
@sylvestre sylvestre added the good first issue For newcomers! label Dec 22, 2023
@ankit-pn
Copy link

hey i want to work on this, it would be great if you assign this to me!

@dvalere dvalere mentioned this issue Dec 23, 2023
Merged
@cakebaker
Copy link
Contributor

@ankit-pn @dvalere already fixed most of the issues in #5696, but feel free to work on the remaining issues

This was referenced Dec 28, 2023
Merged
Merged
@tertsdiepraam
Copy link
Member Author

I've made the list into checkmarks to keep track of all the pages that are correct now.

@zaira-bibi
Copy link

Hi @tertsdiepraam! I would like to work on the remaining issues in the docs.

@tertsdiepraam
Copy link
Member Author

@zaira-bibi feel free to! You can mention me in the PRs that you make to ensure I'll see them.

@zaira-bibi
Copy link

Thanks! I went through the checklist and the repo and it seems like all the issues have been fixed. Kindly let me know if I'm wrong.

@rwdj
Copy link
Contributor
rwdj commented Feb 15, 2025

Went through the list and found inconsistencies for unlink and runcon.

runcon uutils:

runcon [CONTEXT COMMAND [ARG...]]

runcon requires a context command to function:

runcon: No command is specified

unlink uutils:

unlink [FILE]

unlink requires a file to unlink

error: the following required arguments were not provided:
  <FILE>

Every other tool matches. I don't have GNU hashsum to check, but it does have a usage string.

rwdj added a commit to rwdj/uu-coreutils that referenced this issue Feb 16, 2025
@rwdj
Fix some usage strings (uutils#5692)
a38c370 
Fixed runcon usage string to indicate a context command to function.
Fixed unlink usage doc to indicate a file is required.
rwdj added a commit to rwdj/uu-coreutils that referenced this issue Feb 16, 2025
@rwdj
Fix inconsistent usage strings from uutils#5692
3d5dd25 
Fix runcon usage string to indicate a context command to function.

Fix unlink usage doc to indicate a file is required.
rwdj added a commit to rwdj/uu-coreutils that referenced this issue Feb 16, 2025
@rwdj
Fix inconsistent usage strings from uutils#5692
de26605 
Fix runcon usage string to indicate a context command to function.

Fix unlink usage doc to indicate a file is required.
@rwdj rwdj mentioned this issue Feb 16, 2025
Merged
sylvestre added a commit that referenced this issue Feb 16, 2025
@sylvestre
Merge pull request #7303 from rwdj/fix-5692-usage-strings
511590a 
Fix usage strings for #5692
@tertsdiepraam
Copy link
Member Author

I don't have GNU hashsum to check, but it does have a usage string.

That's right, because it doesn't exist :)

The usage string for everything based on hashsum are missing.

This is still an issue for everything that uses hashsum under the hood like sha224sum.

The test lines also need to be fixed still, I think.

@Its-Just-Nans
Copy link
Contributor
Its-Just-Nans commented May 13, 2025 •
edited
Loading

Hi

This is still an issue for everything that uses hashsum under the hood like sha224sum.

Is this still valid?

#!/bin/bash

for i in md5sum sha1sum sha224sum sha256sum sha384sum sha512sum sha3sum sha3-224sum sha3-256sum sha3-384sum sha3-512sum shake128sum shake256sum b2sum b3sum; do
    cargo run $i -h 2>&1 | grep Usage
done
Usage: target/debug/coreutils md5sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha1sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha224sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha256sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha384sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha512sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-224sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-256sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-384sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-512sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils shake128sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils shake256sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils b2sum --<digest> [OPTIONS]... [FILE]...
Usage: target/debug/coreutils b3sum --<digest> [OPTIONS]... [FILE]...

And also

The test lines also need to be fixed still, I think.

cargo run [  --help
Check file types and compare values.

Usage: test EXPRESSION
       [
       [ EXPRESSION ]
       [ ]
       [ OPTION
       ]

Options:
  -h, --help     Print help
  -V, --version  Print version
....

This issue is closeable no ?

@rwdj
Copy link
Contributor
rwdj commented May 14, 2025 •
edited
Loading

Is this still valid?

I don't think it was. If I recall when I checked, all the *sums had usage strings. All it needed was a minor doc correction to require --<digest> for hashsum.

But I note (contrary to your output) that --<digest> should only be required when it's hashsum and not required for the other *sum.

@tertsdiepraam
Copy link
Member Author

It still doesn't work online I think: https://uutils.github.io/coreutils/docs/utils/sha256sum.html

(Unless that has been fixed since the last release and I missed that)

@Its-Just-Nans Its-Just-Nans mentioned this issue May 15, 2025
Open
@Its-Just-Nans
Copy link
Contributor

Hi

With #7936

Usage: target/debug/coreutils md5sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha1sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha224sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha256sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha384sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha512sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-224sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-256sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-384sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils sha3-512sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils shake128sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils shake256sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils b2sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils b3sum [OPTIONS]... [FILE]...
Usage: target/debug/coreutils hashsum --<digest> [OPTIONS]... [FILE]...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue For newcomers!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@cakebaker @sylvestre @tertsdiepraam @rwdj @Its-Just-Nans @ankit-pn @zaira-bibi
0