Credits:
Matt Kraai - initial writeup
Mark Whitley - the remix
-
+Thomas Lundquist - Added stuff for the new directory layout.
Initial Write
-------------
First, write your applet. Be sure to include copyright information at the
top, such as who you stole the code from and so forth. Also include the
mini-GPL boilerplate. Be sure to name the main function <applet>_main instead
-of main. And be sure to put it in <applet>.c. For a new applet mu, here is
-the code that would go in mu.c:
+of main. And be sure to put it in <applet>.c. Usage do not have to be taken care of by your applet.
+
+For a new applet mu, here is the code that would go in mu.c:
----begin example code------
libbb.
+Placement / Directory
+---------------------
+
+Find the appropriate directory for your new applet.
+
+Make sure you find the appropriate places in the files, the applets are
+sorted alphabetically.
+
+Add the applet to Makefile.in in the chosen applet directory:
+
+obj-$(CONFIG_MU) += mu.o
+
+Add the applet to Config.in in the chosen applet directory:
+
+config CONFIG_MU
+ bool "MU"
+ default n
+ help
+ Returns an indeterminate value.
+
+
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 CONFIG_MU
/* all programs below here are alphabetically "greater than" 'mu' */
-Finally, add a define for your applet to Config.h:
+Finally, add a define for your applet to include/config.h
- #define CONFIG_MU
+ #undef 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@busybox.net. Sending patches as attachments is preferred, but
-not required.
+Then create a diff -urN of the files you added (<appletdir/><applet>.c,
+include/usage.c, include/applets.h, include/config.h, <appletdir>/Makefile.in, <appletdir>/config.in)
+and send it to the mailing list:
+busybox@busybox.net.
+Sending patches as attachments is preferred, but not required.