Make autodocifier suck less. It still doesn't handle nested USE( USE() ) case
(the inner USE() winds up in the output), but making it recursive involves
getting perl to accept a "for" loop and it's telling me that "break" is an
unrecognized bareword and I hate perl. This is at least an improvement.
o echo_example_usage
needed to escape some backslashes in an inner quote
o find_full_usage
missing a \n at the end of the -name line
? getopt_full_usage
the -o line has tab issues, but I didn't fix them.
o length_example_usage
removed some double-quotes that were within an inner quotes
o printf_example_usage
needed to escape a backslash in an inner quote
o sort_example_usage
needed to escape some backslashes and double quotes in an inner quote
o tftp_full_usage
s/nameing/naming/;
o umount_full_usage
remove colons after options for consistency w/ other full_usage messages
o uniq_example_usage
needed to escape some backslashes and double quotes in an inner quote
- TODO xargs -l ?
- docs/autodocifier.pl POD && comment updates
- docs/busybox_footer.pod added Larry Doolittle and Sterling Huxley
line appears at the bottom instead of the top. The
indentation semantics of POD make the first item in
the (=over,=back) block look weird the other way.
- implemented a way to encode example usage into usage.h
One would define a macro called "${applet}_example_usage"
which would expand to the example text.
- The example usage is considered optional, but trivial and
full usage are not.
Here's an example using chown.
---- before
#define chown_trivial_usage \
"[OPTION]... OWNER[<.|:>[GROUP] FILE..."
#define chown_full_usage \
"Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \
"\nOptions:\n" \
"\t-R\tChanges files and directories recursively."
#define chown_example_usage \
"\t$ ls -l /tmp/foo\n" \
"\t-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \
"\t$ chown root /tmp/foo\n" \
"\t$ ls -l /tmp/foo\n" \
"\t-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \
"\t$ chown root.root /tmp/foo\n" \
"\tls -l /tmp/foo\n" \
"\t-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n"
---- after
=item I<chown>
chown [OPTION]... OWNER[<.|:>[GROUP] FILE...
Change the owner and/or group of each FILE to OWNER and/or GROUP.
Options:
-R Changes files and directories recursively.
Example:
$ ls -l /tmp/foo
-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo
$ chown root /tmp/foo
$ ls -l /tmp/foo
-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo
$ chown root.root /tmp/foo
ls -l /tmp/foo
-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo
-------------------------------
* make headers and footers for both the POD and SGML content
* make an SGML generator
* finish the command-line handling
Also, some of the documentation in usage.h will have to
be adjusted. expr needs some lines to be indented, and
ls has a stray comma. I may have missed some things...
but it looks OK for the most part.
