aboutsummaryrefslogtreecommitdiff
path: root/docs/autodocifier.pl
AgeCommit message (Collapse)Author
2009-04-21*: mass renaming of USE_XXXX to IF_XXXXDenis Vlasenko
and SKIP_XXXX to IF_NOT_XXXX - the second one was especially badly named. It was not skipping anything!
2008-09-01- add ether-wake to the hardcoded(argh!) list of APPLET_ODDNAMEBernhard Reutner-Fischer
2008-08-31build system: fix "Possible unintended interpolation of @host"Denis Vlasenko
message
2007-01-22- sed -i -e "/\$Id:/d;"Bernhard Reutner-Fischer
2006-10-24Put up BusyBox 1.2.2 and get out of Denis' way. Also minor tweak to Rob Landley
autodocifier.pl so USAGE_ macros that haven't been converted to USE_ yet get correctly stripped out when generating BusyBox.html.
2006-07-27And now, with a for loop, so it can handle the nested USE() case.Rob Landley
2006-07-27I touched perl. I feel dirty.Rob Landley
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.
2006-02-07Cristian Ionescu-Idbohrn writes:Mike Frysinger
force enough space padding so that applet names always end up on their own line
2006-02-07space out supported applet names so the config list doesnt wrap on an 80col ↵Mike Frysinger
terminal
2006-02-06get rid of warnings with applets that have no usage and get rid of pointless ↵Mike Frysinger
--- separator between applets
2006-02-05Rob Sullivan writes: Here's a patch to autogenerate the list of applets in ↵Mike Frysinger
the Busybox documentation
2004-04-06Eliminate all trace of the sgml based docs. It was a noble effort,Eric Andersen
but it just never worked out...
2004-03-13Fix some doc generation problemsEric Andersen
2003-07-14Update a bunch of docs. Run a script to update my email addr.Eric Andersen
2001-10-31- fixed typosJohn Beppu
- thinking about how to generate Configure.help...
2001-10-24Major rework of the directory structure and the entire build system.Eric Andersen
-Erik
2001-04-17- usage.hJohn Beppu
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-10Fix double quote handling.Matt Kraai
2001-04-05- autodocifier.pl :: continuation() was modified such that '#'John Beppu
is handled correctly.
2001-04-05- documentation updates and a minor tweak to POD generationJohn Beppu
2001-03-15- generated middle section of busybox.pod w/ autodocifier.plJohn Beppu
- updated autodocifier.pl to use tab to indent example section
2001-03-15- properly indent Examples section in pod generatorJohn Beppu
2001-03-15Update the documentation so examples are autoincluded in the output text.Eric Andersen
Fix up docs/busybox.pod with the latest autogenerated output. -Erik
2001-03-06minor cleanupJohn Beppu
2001-02-26- changed the way POD is generated such that the dashedJohn Beppu
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-24...John Beppu
2001-02-24refinementJohn Beppu
2001-02-23formatting ...John Beppu
2001-02-23Added some documentation and made --sgml use sgml_from_usage().John Beppu
pod_from_usage() is the default generator.
2001-02-23During POD generation, it inserts a blank line before linesJohn Beppu
that were intended to be indented.
2001-02-23forgot to remove some debugging noiseJohn Beppu
2001-02-23This one should be able to deal with the USAGE macros a littleJohn Beppu
more robustly. I also blow away any USAGE_NOT_\w+ macros.
2001-02-23forgot a comma.John Beppu
2001-02-23I can't leave it alone.John Beppu
2001-02-23minor cleanup... all that's left to do isJohn Beppu
* 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-23This is the remixed autodocufier.pl.John Beppu
2001-02-22First pass at making up an automagical usage message extractor, whichEric Andersen
will be used (when it works) to autogenerate documentation. Based on code written by Mark Whitley.