Credits:
Matt Kraai - initial writeup
Mark Whitley - the remix
-
+Thomas Lundquist - Added stuff for the new directory layout.
Initial Write
-------------
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)
---------------
-Next, add usage information for you applet to usage.h. This should look like
-the following:
+Next, add usage information for you applet to include/usage.h.
+This should look like the following:
#define mu_trivial_usage \
"-[abcde] FILES"
Header Files
------------
-Next, add an entry to applets.h. Be *sure* to keep the list in alphabetical
-order, or else it will break the binary-search lookup algorithm in busybox.c
-and the Gods of BusyBox smite you. Yea, verily:
+Next, add an entry to include/applets.h. Be *sure* to keep the list
+in alphabetical order, or else it will break the binary-search lookup
+algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily:
/* all programs above here are alphabetically "less than" 'mu' */
- #ifdef BB_MU
+ #ifdef CONFIG_MU
APPLET("mu", mu_main, _BB_DIR_USR_BIN, mu_usage)
#endif
/* all programs below here are alphabetically "greater than" 'mu' */
Finally, add a define for your applet to Config.h:
- #define BB_MU
+ #define CONFIG_MU
Documentation
If you're feeling especially nice, you should also document your applet in the
docs directory (but nobody ever does that).
+Adding some text to docs/Configure.help is a nice start.
+
The Grand Announcement
----------------------
Then create a diff -urN of the files you added (<applet>.c, usage.c,
applets.h, Config.h) and send it to the mailing list:
-busybox@opensource.lineo.com. Sending patches as attachments is preferred, but
+busybox@busybox.net. Sending patches as attachments is preferred, but
not required.