summaryrefslogtreecommitdiff
path: root/docs/new-applet-HOWTO.txt
diff options
context:
space:
mode:
authorMatt Kraai <kraai@debian.org>2002-03-18 16:03:00 +0000
committerMatt Kraai <kraai@debian.org>2002-03-18 16:03:00 +0000
commit3b1cbd7bec7fe53637621972469b4663413ea7ce (patch)
tree921abf313924ce625f32fb3da90359ed2677d8a9 /docs/new-applet-HOWTO.txt
parent38ddbed4c1144370169611bd94d3b0662961dfbb (diff)
downloadbusybox-w32-3b1cbd7bec7fe53637621972469b4663413ea7ce.tar.gz
busybox-w32-3b1cbd7bec7fe53637621972469b4663413ea7ce.tar.bz2
busybox-w32-3b1cbd7bec7fe53637621972469b4663413ea7ce.zip
Thomas Lundquist
* docs/new-applet-HOWTO.txt: Update for new directory structure.
Diffstat (limited to 'docs/new-applet-HOWTO.txt')
-rw-r--r--docs/new-applet-HOWTO.txt28
1 files changed, 22 insertions, 6 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt
index edf7eeee8..7cae30b45 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.
6Credits: 6Credits:
7Matt Kraai - initial writeup 7Matt Kraai - initial writeup
8Mark Whitley - the remix 8Mark Whitley - the remix
9 9Thomas Lundquist - Added stuff for the new directory layout.
10 10
11Initial Write 11Initial Write
12------------- 12-------------
@@ -81,11 +81,25 @@ program that could be useful in another program, consider putting them in
81libbb. 81libbb.
82 82
83 83
84Placement / Directory
85---------------------
86
87Find the appropriate directory for your new applet.
88
89Add the applet to the applet directory Makefile:
90
91obj-$(CONFIG_MU) += mu.o
92
93Add the applet to the applet directory config.in:
94
95bool 'mu' CONFIG_MU
96
97
84Usage String(s) 98Usage String(s)
85--------------- 99---------------
86 100
87Next, add usage information for you applet to usage.h. This should look like 101Next, add usage information for you applet to include/usage.h.
88the following: 102This should look like the following:
89 103
90 #define mu_trivial_usage \ 104 #define mu_trivial_usage \
91 "-[abcde] FILES" 105 "-[abcde] FILES"
@@ -104,9 +118,9 @@ currently exist in usage.h.)
104Header Files 118Header Files
105------------ 119------------
106 120
107Next, add an entry to applets.h. Be *sure* to keep the list in alphabetical 121Next, add an entry to include/applets.h. Be *sure* to keep the list
108order, or else it will break the binary-search lookup algorithm in busybox.c 122in alphabetical order, or else it will break the binary-search lookup
109and the Gods of BusyBox smite you. Yea, verily: 123algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily:
110 124
111 /* all programs above here are alphabetically "less than" 'mu' */ 125 /* all programs above here are alphabetically "less than" 'mu' */
112 #ifdef CONFIG_MU 126 #ifdef CONFIG_MU
@@ -126,6 +140,8 @@ Documentation
126If you're feeling especially nice, you should also document your applet in the 140If you're feeling especially nice, you should also document your applet in the
127docs directory (but nobody ever does that). 141docs directory (but nobody ever does that).
128 142
143Adding some text to docs/Configure.help is a nice start.
144
129 145
130The Grand Announcement 146The Grand Announcement
131---------------------- 147----------------------