[BusyBox] Documentation of configuration choices

[Stewart Brodie]

In message <20020807132227.GA8807 at codepoet.org>
          Erik Andersen <andersen at codepoet.org> wrote:

> On Wed Aug 07, 2002 at 02:16:22PM +0100, Stewart Brodie wrote:
> > One thing that has always bugged me about busybox is that there is little
> > or no help text to go with the menu configuration.  Although I recognise
> > many of the utilities and functionality that I do or do not want, IMHO it
> > would be handy to have some brief comment about each entry.
> > 
> > This might be something that is done in preparation for, say, a 0.61
> > release? :-)))  That might even be an offer of doing some of the work if
> > people think it's worthwhile.
> 
> You tried setting CONFIG_FEATURE_VERBOSE_USAGE and that was not sufficient? 

Well, you have to build it all in and then ask each utility for help then to
see what it does.  I would find it handy to be able to just press ? when
running make menuconfig to see at a glance what each tool is.

> I'm happy to accept patches to add better documentation,

It might be possible to autogenerate the docs/Configure.help from the
include/usage.h file - at least for a first pass, but some of the help
strings change depending on feature options of some applets, like ls and
mount.

I guess I just got used to being able to use menuconfig's built-in help
system when configuring Linux kernels.

I'll have a look at whether doing this is feasible: would you have any
objection to having an extra tool to go in scripts/ to do this?  In C?

-- 
Stewart Brodie, Senior Software Engineer
Pace Micro Technology PLC
645 Newmarket Road
Cambridge, CB5 8PB, United Kingdom         WWW: http://www.pacemicro.com/