uutils/coreutils

Some docs issues

Open

#5,692 opened on Dec 22, 2023

View on GitHub
 (14 comments) (1 reaction) (0 assignees)Rust (1,852 forks)batch import
good first issue

Repository metrics

Stars
 (23,246 stars)
PR merge metrics
 (Avg merge 5d 23h) (239 merged PRs in 30d)

Description

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

Contributor guide