[Toybox] consistency in command specification

Isaac ibid.ag at gmail.com
Fri Aug 16 22:03:50 PDT 2013


On Wed, Aug 14, 2013 at 09:55:17PM -0500, Rob Landley wrote:
> >+config SU
> >+  bool "su"
> >+  default n
> >+  help
> >+    usage: su [-lmp] [-c cmd] [-s shell] [user [argu...]]
> 
> I tend to have things like CMD SHELL USER be all caps to show it's
> not a literal argument. I also tend to say ARGS instead of argu
> (there's a couple existing instances in the tree, trying to be
> consistent).
> 
> I need to do a cleanup pass actually. df has [FILESYSTEM ...] when
> it should probably have FILESYSTEM[...]. And of course chgrp has
> file... chmod has FILE... cut has [FILE]... xzcat has [filename...]
> and so on. (It'd be nice there was a standard on this. I'm sort of
> copying what the man pages do but it's cargo cult documenting...)
> 
> Right, throw another todo item on the heap.
> 

diff --git a/toys/pending/xzcat.c b/toys/pending/xzcat.c
index 951ead0..842f8c5 100644
--- a/toys/pending/xzcat.c
+++ b/toys/pending/xzcat.c
@@ -12,7 +12,7 @@ config XZCAT
   bool "xzcat"
   default n
   help
-    usage: xzcat [filename...]
+    usage: xzcat [FILE...]
     
     Decompress listed files to stdout. Use stdin if no files listed.
 

To be consistent.




More information about the Toybox mailing list