X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=docs%2Fnew-applet-HOWTO.txt;h=2fc95d36df4834a360ee43f01f9b1d3b6ebd8b64;hb=ec91de762a7d14cbed5e5972279d2378ae2e5a27;hp=1f5c3ebd5318e772d50f3d423ee129394e4a4ca9;hpb=2e6d3cfa82eb64fffe53ccb5669aa7146228cf8f;p=oweals%2Fbusybox.git

diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt
index 1f5c3ebd5..2fc95d36d 100644
--- a/docs/new-applet-HOWTO.txt
+++ b/docs/new-applet-HOWTO.txt
@@ -6,7 +6,7 @@ This document details the steps you must take to add a new applet to BusyBox.
 Credits:
 Matt Kraai - initial writeup
 Mark Whitley - the remix
-
+Thomas Lundquist - Added stuff for the new directory layout.
 
 Initial Write
 -------------
@@ -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------
 
@@ -81,11 +82,32 @@ program that could be useful in another program, consider putting them in
 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"
@@ -104,20 +126,20 @@ currently exist in usage.h.)
 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:
+Finally, add a define for your applet to include/config.h
 
-	#define BB_MU
+	#undef CONFIG_MU
 
 
 Documentation
@@ -126,13 +148,16 @@ 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
-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.