summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/new-applet-HOWTO.txt31
1 files changed, 20 insertions, 11 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt
index 7cae30b..5494095 100644
--- a/docs/new-applet-HOWTO.txt
+++ b/docs/new-applet-HOWTO.txt
@@ -14,8 +14,9 @@ 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------
@@ -86,13 +87,20 @@ Placement / Directory
Find the appropriate directory for your new applet.
-Add the applet to the applet directory Makefile:
+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 the applet directory config.in:
+Add the applet to Config.in in the chosen applet directory:
-bool 'mu' CONFIG_MU
+config CONFIG_MU
+ bool "MU"
+ default n
+ help
+ Returns an indeterminate value.
Usage String(s)
@@ -129,9 +137,9 @@ algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily:
/* 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
@@ -146,9 +154,10 @@ 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.