diff options
author | Glenn L McGrath <bug1@ihug.co.nz> | 2003-10-01 11:33:46 +0000 |
---|---|---|
committer | Glenn L McGrath <bug1@ihug.co.nz> | 2003-10-01 11:33:46 +0000 |
commit | 9c91e4142d5bbc74a0c4453055537931c1274757 (patch) | |
tree | c40903ccafafa09b322f637c3f6d0227d1b2f591 /docs/new-applet-HOWTO.txt | |
parent | 0ad4daa54ea646ef60eab56b664d97386cd95a85 (diff) | |
download | busybox-w32-9c91e4142d5bbc74a0c4453055537931c1274757.tar.gz busybox-w32-9c91e4142d5bbc74a0c4453055537931c1274757.tar.bz2 busybox-w32-9c91e4142d5bbc74a0c4453055537931c1274757.zip |
Thomas Lundquist, update for current structure
Diffstat (limited to 'docs/new-applet-HOWTO.txt')
-rw-r--r-- | docs/new-applet-HOWTO.txt | 31 |
1 files changed, 20 insertions, 11 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt index 7cae30b45..54940957c 100644 --- a/docs/new-applet-HOWTO.txt +++ b/docs/new-applet-HOWTO.txt | |||
@@ -14,8 +14,9 @@ Initial Write | |||
14 | First, write your applet. Be sure to include copyright information at the | 14 | First, write your applet. Be sure to include copyright information at the |
15 | top, such as who you stole the code from and so forth. Also include the | 15 | top, such as who you stole the code from and so forth. Also include the |
16 | mini-GPL boilerplate. Be sure to name the main function <applet>_main instead | 16 | mini-GPL boilerplate. Be sure to name the main function <applet>_main instead |
17 | of main. And be sure to put it in <applet>.c. For a new applet mu, here is | 17 | of main. And be sure to put it in <applet>.c. Usage do not have to be taken care of by your applet. |
18 | the code that would go in mu.c: | 18 | |
19 | For a new applet mu, here is the code that would go in mu.c: | ||
19 | 20 | ||
20 | ----begin example code------ | 21 | ----begin example code------ |
21 | 22 | ||
@@ -86,13 +87,20 @@ Placement / Directory | |||
86 | 87 | ||
87 | Find the appropriate directory for your new applet. | 88 | Find the appropriate directory for your new applet. |
88 | 89 | ||
89 | Add the applet to the applet directory Makefile: | 90 | Make sure you find the appropriate places in the files, the applets are |
91 | sorted alphabetically. | ||
92 | |||
93 | Add the applet to Makefile.in in the chosen applet directory: | ||
90 | 94 | ||
91 | obj-$(CONFIG_MU) += mu.o | 95 | obj-$(CONFIG_MU) += mu.o |
92 | 96 | ||
93 | Add the applet to the applet directory config.in: | 97 | Add the applet to Config.in in the chosen applet directory: |
94 | 98 | ||
95 | bool 'mu' CONFIG_MU | 99 | config CONFIG_MU |
100 | bool "MU" | ||
101 | default n | ||
102 | help | ||
103 | Returns an indeterminate value. | ||
96 | 104 | ||
97 | 105 | ||
98 | Usage String(s) | 106 | Usage String(s) |
@@ -129,9 +137,9 @@ algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily: | |||
129 | /* all programs below here are alphabetically "greater than" 'mu' */ | 137 | /* all programs below here are alphabetically "greater than" 'mu' */ |
130 | 138 | ||
131 | 139 | ||
132 | Finally, add a define for your applet to Config.h: | 140 | Finally, add a define for your applet to include/config.h |
133 | 141 | ||
134 | #define CONFIG_MU | 142 | #undef CONFIG_MU |
135 | 143 | ||
136 | 144 | ||
137 | Documentation | 145 | Documentation |
@@ -146,9 +154,10 @@ Adding some text to docs/Configure.help is a nice start. | |||
146 | The Grand Announcement | 154 | The Grand Announcement |
147 | ---------------------- | 155 | ---------------------- |
148 | 156 | ||
149 | Then create a diff -urN of the files you added (<applet>.c, usage.c, | 157 | Then create a diff -urN of the files you added (<appletdir/><applet>.c, |
150 | applets.h, Config.h) and send it to the mailing list: | 158 | include/usage.c, include/applets.h, include/config.h, <appletdir>/Makefile.in, <appletdir>/config.in) |
151 | busybox@busybox.net. Sending patches as attachments is preferred, but | 159 | and send it to the mailing list: |
152 | not required. | 160 | busybox@busybox.net. |
153 | 161 | ||
162 | Sending patches as attachments is preferred, but not required. | ||
154 | 163 | ||