coreutils icon indicating copy to clipboard operation
coreutils copied to clipboard

Some docs issues

Open tertsdiepraam opened this issue 1 year ago • 12 comments

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

  • [x] join should be join [OPTION]... FILE1 FILE2
  • [x] cut should be cut OPTION... [FILE]...
  • [x] mkdir should be mkdir [OPTION]... DIRECTORY... (for some reason it says [USER] now 😄 )
  • [ ] The usage string for everything based on hashsum are missing.
  • [x] more now says more [OPTIONS] <FILE>... which matches util-linux but uses a different syntax than GNU, which would be more [OPTIONS]... FILE...
  • [x] nohup FLAG should be nohup OPTION
  • [x] pr should be pr [OPTION]... [FILE]...
  • [x] printenv should be printenv [OPTION]... [VARIABLE]...
  • [x] printf should have the strings printf FORMAT [ARGUMENT]... and printf OPTION
  • [x] basenc has a " at the end of the usage string that shouldn't be there.
  • [x] runcon has "; at the end of the usage string that shouldn't be there.
  • [x] shuf has ; at the end of the usage string that shouldn't be there.
  • [x] 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.
  • [x] uniq should be uniq [OPTION]... [INPUT [OUTPUT]]
  • [x] unlink should be unlink FILE and unlink OPTION
  • [x] vdir is missing documentation

tertsdiepraam avatar Dec 22 '23 10:12 tertsdiepraam

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

ankit-pn avatar Dec 23 '23 02:12 ankit-pn

@ankit-pn @dvalere already fixed most of the issues in https://github.com/uutils/coreutils/pull/5696, but feel free to work on the remaining issues

cakebaker avatar Dec 23 '23 15:12 cakebaker

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

tertsdiepraam avatar Feb 07 '24 11:02 tertsdiepraam