[BusyBox] usage.h and ##_example_usage ???

Steven Scholz steven.scholz at imc-berlin.de
Mon Jul 26 08:15:51 UTC 2004


Erik Andersen wrote:

> On Mon Jul 26, 2004 at 09:48:44AM +0200, Steven Scholz wrote:
> 
>>I wanted to know, what the *_example_usage defines are for!
>>*_trivial_usage and *_full_usage are obvious. But I could not
>>find any reference to *_example_usage...
> 
> 
> Ahh, ok.  :-)
> 
> If you look at the docs:
> 	http://busybox.net/downloads/BusyBox.html
> for example
> 	http://busybox.net/downloads/BusyBox.html#item_chmod
> 
> you will see several examples of how to use the 'chmod' applet.
> Those examples are created via the *_example_usage define
> 'chmod_example_usage'.  A similar feature is implemented using
> *_notes_usage, currently only used for 'init_notes_usage' and
> 'lash_notes_usage'.  You can see the results of such with the
> 	http://busybox.net/downloads/BusyBox.html#item_init
> entry,

Ah, I see. I obviously did not look deep enough.

So that's you're way of automatically creating documentation.

Thanks!

-- 
Steven



More information about the busybox mailing list