mirror of
https://github.com/sheumann/hush.git
synced 2024-12-27 01:32:08 +00:00
Thomas Lundquist
* docs/new-applet-HOWTO.txt: Update for new directory structure.
This commit is contained in:
parent
38ddbed4c1
commit
3b1cbd7bec
@ -6,7 +6,7 @@ This document details the steps you must take to add a new applet to BusyBox.
|
|||||||
Credits:
|
Credits:
|
||||||
Matt Kraai - initial writeup
|
Matt Kraai - initial writeup
|
||||||
Mark Whitley - the remix
|
Mark Whitley - the remix
|
||||||
|
Thomas Lundquist - Added stuff for the new directory layout.
|
||||||
|
|
||||||
Initial Write
|
Initial Write
|
||||||
-------------
|
-------------
|
||||||
@ -81,11 +81,25 @@ program that could be useful in another program, consider putting them in
|
|||||||
libbb.
|
libbb.
|
||||||
|
|
||||||
|
|
||||||
|
Placement / Directory
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Find the appropriate directory for your new applet.
|
||||||
|
|
||||||
|
Add the applet to the applet directory Makefile:
|
||||||
|
|
||||||
|
obj-$(CONFIG_MU) += mu.o
|
||||||
|
|
||||||
|
Add the applet to the applet directory config.in:
|
||||||
|
|
||||||
|
bool 'mu' CONFIG_MU
|
||||||
|
|
||||||
|
|
||||||
Usage String(s)
|
Usage String(s)
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
Next, add usage information for you applet to usage.h. This should look like
|
Next, add usage information for you applet to include/usage.h.
|
||||||
the following:
|
This should look like the following:
|
||||||
|
|
||||||
#define mu_trivial_usage \
|
#define mu_trivial_usage \
|
||||||
"-[abcde] FILES"
|
"-[abcde] FILES"
|
||||||
@ -104,9 +118,9 @@ currently exist in usage.h.)
|
|||||||
Header Files
|
Header Files
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Next, add an entry to applets.h. Be *sure* to keep the list in alphabetical
|
Next, add an entry to include/applets.h. Be *sure* to keep the list
|
||||||
order, or else it will break the binary-search lookup algorithm in busybox.c
|
in alphabetical order, or else it will break the binary-search lookup
|
||||||
and the Gods of BusyBox smite you. Yea, verily:
|
algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily:
|
||||||
|
|
||||||
/* all programs above here are alphabetically "less than" 'mu' */
|
/* all programs above here are alphabetically "less than" 'mu' */
|
||||||
#ifdef CONFIG_MU
|
#ifdef CONFIG_MU
|
||||||
@ -126,6 +140,8 @@ Documentation
|
|||||||
If you're feeling especially nice, you should also document your applet in the
|
If you're feeling especially nice, you should also document your applet in the
|
||||||
docs directory (but nobody ever does that).
|
docs directory (but nobody ever does that).
|
||||||
|
|
||||||
|
Adding some text to docs/Configure.help is a nice start.
|
||||||
|
|
||||||
|
|
||||||
The Grand Announcement
|
The Grand Announcement
|
||||||
----------------------
|
----------------------
|
||||||
|
Loading…
Reference in New Issue
Block a user