[BusyBox] new-applet-HOWTO.txt.diff
Thomas Lundquist
lists at zelow.no
Sun Mar 17 05:04:03 UTC 2002
I think I got most of the changes needed to this small doc file to
adapt it to the new directory layout.
I tried adding arp from net-tools but that wasn't really a good idea
but at least I got this diff done.
Thomas.
-------------- next part --------------
Index: new-applet-HOWTO.txt
===================================================================
RCS file: /var/cvs/busybox/docs/new-applet-HOWTO.txt,v
retrieving revision 1.6
diff -u -r1.6 new-applet-HOWTO.txt
--- new-applet-HOWTO.txt 8 Dec 2001 01:56:07 -0000 1.6
+++ new-applet-HOWTO.txt 17 Mar 2002 11:59:02 -0000
@@ -6,7 +6,7 @@
Credits:
Matt Kraai - initial writeup
Mark Whitley - the remix
-
+Thomas Lundquist - Added stuff for the new directory layout.
Initial Write
-------------
@@ -81,11 +81,25 @@
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"
@@ -104,9 +118,9 @@
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
@@ -125,6 +139,8 @@
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
More information about the busybox
mailing list