Commit Graph

23 Commits

Author SHA1 Message Date
ce22feea01 - fixed typos
- thinking about how to generate Configure.help...
2001-10-31 04:29:18 +00:00
bdfd0d78bc Major rework of the directory structure and the entire build system.
-Erik
2001-10-24 05:00:29 +00:00
5d81768cf1 - usage.h
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
2001-04-17 17:09:34 +00:00
4e853560f5 Fix double quote handling. 2001-04-10 00:00:05 +00:00
79359d87e8 - autodocifier.pl :: continuation() was modified such that '#'
is handled correctly.
2001-04-05 20:03:33 +00:00
9a1395b9fd - documentation updates and a minor tweak to POD generation 2001-04-05 19:35:17 +00:00
e708cb5f9a - generated middle section of busybox.pod w/ autodocifier.pl
- updated autodocifier.pl to use tab to indent example section
2001-03-15 21:08:01 +00:00
af9e533a54 - properly indent Examples section in pod generator 2001-03-15 20:49:25 +00:00
0d3a02eba7 Update the documentation so examples are autoincluded in the output text.
Fix up docs/busybox.pod with the latest autogenerated output.
 -Erik
2001-03-15 18:14:25 +00:00
138ece09b5 minor cleanup 2001-03-06 19:25:25 +00:00
d11578f916 - changed the way POD is generated such that the dashed
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


-------------------------------
2001-02-26 02:50:11 +00:00
37977622c4 ... 2001-02-24 14:44:25 +00:00
7d597c4833 refinement 2001-02-24 14:37:48 +00:00
dbfff6cbde formatting ... 2001-02-23 17:55:03 +00:00
e6967b20cb Added some documentation and made --sgml use sgml_from_usage().
pod_from_usage() is the default generator.
2001-02-23 17:51:08 +00:00
8373e70c55 During POD generation, it inserts a blank line before lines
that were intended to be indented.
2001-02-23 17:41:41 +00:00
15f9b92127 forgot to remove some debugging noise 2001-02-23 16:16:08 +00:00
df1e9daf30 This one should be able to deal with the USAGE macros a little
more robustly.  I also blow away any USAGE_NOT_\w+ macros.
2001-02-23 16:15:34 +00:00
2498b155fd forgot a comma. 2001-02-23 13:04:39 +00:00
b249fbb1dc I can't leave it alone. 2001-02-23 03:12:45 +00:00
8c16bc5012 minor cleanup... all that's left to do is
* 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.
2001-02-23 02:54:31 +00:00
4a25d8c9c3 This is the remixed autodocufier.pl. 2001-02-23 02:33:28 +00:00
e13bc0bc68 First pass at making up an automagical usage message extractor, which
will be used (when it works) to autogenerate documentation.  Based on
code written by Mark Whitley.
2001-02-22 22:47:06 +00:00