hush/docs
David Krakov 29ec116037 POSIX conformance documentation for busybox
Attached a start for POSIX conformance documentation for busybox (see
TODO file and discussion last week).
A table of all options as defined by POSIX and as implemented by
busybox (see for a FreeBSD example
http://people.freebsd.org/~schweikh/posix-utilities.html).

Only the tools that are stand-alone applets are documented (not ash
built-ins as 'read'), as there are multiple shells.
When there are two versions (echo) the stand-alone version was
checked. I think this may be the wrong way to go, as most users will
probably use the built-in version - but which shell?

The table was auto-generated by running, for each POSIX utility,
latest git allyesconfig* "busybox <tool> --help" and parsing the
output, and comparing that to tool options extracted from its man page
at http://www.opengroup.org/onlinepubs/9699919799/.
This means that it the usage string is not correct, the table is also
wrong. I noticed that for 'kill', for example, the usage string does
not mention the -s, -q, -o options.
For each option is set whether it exists in busybox and if it is, is
it compliant to the standard. Of course, checking compliance can only
be done manually - a process which will probably take some time (see
'cat' for example).

I didn't post the auto-generation script (python, ugly) because the
table will now change manually; I can post it if there is anyone
interested.

As for the tools not implemented by busybox at all, I think most of
them are indeed fairly esotetic. Some I was suprised to see missing
are link, file, newgrp, unlink.

* Well, almost allyesconfig - but nothing very POSIX-y was disabled.

Signed-off-by: David Krakov <krakov@gmail.org>
Signed-off-by: Mike Frysinger <vapier@gentoo.org>
2009-05-26 19:42:34 -04:00
..
cgi fix accumulated whitespace and indentation damage 2007-03-20 11:30:28 +00:00
.gitignore add .gitignore files 2009-05-05 09:05:30 -04:00
autodocifier.pl *: mass renaming of USE_XXXX to IF_XXXX 2009-04-21 11:09:40 +00:00
busybox_footer.pod remove last source id 2007-07-13 05:03:46 +00:00
busybox_header.pod - improve documentation a bit 2008-08-21 13:22:44 +00:00
contributing.txt - correct typo 2006-03-23 16:52:59 +00:00
ctty.htm *: fix various kinds of damage to letter 'c' in Arkadiusz Mickiewicz' surname. 2008-03-17 09:29:43 +00:00
draft-coar-cgi-v11-03-clean.html fix accumulated whitespace and indentation damage 2007-03-20 11:30:28 +00:00
ifupdown_design.txt Start a small document "why ifupdown is bad" 2007-08-25 22:16:04 +00:00
keep_data_small.txt *: add optimization barrier to all "G trick" locations 2008-02-27 18:41:59 +00:00
logging_and_backgrounding.txt ftpd: stop unconditional logging to syslog. This was the only applet 2009-03-11 15:07:44 +00:00
mdev.txt watchdog: add -T option 2008-09-07 23:22:08 +00:00
new-applet-HOWTO.txt *: mass renaming of USE_XXXX to IF_XXXX 2009-04-21 11:09:40 +00:00
nofork_noexec.txt tac: new applet. ~240 bytes. 2008-01-06 06:27:17 +00:00
posix_conformance.txt POSIX conformance documentation for busybox 2009-05-26 19:42:34 -04:00
Serial-Programming-HOWTO.txt move documentation to docs/ 2008-11-08 22:31:19 +00:00
sigint.htm Trailing whitespace removal over entire tree 2007-01-11 17:20:00 +00:00
style-guide.txt s/#ifdef CONFIG_/#if ENABLE_/g 2007-08-13 10:36:25 +00:00
tar_pax.txt Trailing whitespace removal over entire tree 2007-01-11 17:20:00 +00:00