emo/busybox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs/new-applet-HOWTO.txt

Browse Source 
Signed-off-by: Holger Blasum <hbl@sysgo.com>
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
This commit is contained in:
Holger Blasum 2010-10-28 20:37:05 +02:00 committed by Denys Vlasenko
parent 756e95e782
commit b27d62af8b
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/new-applet-HOWTO.txt
View File

@ -99,14 +99,14 @@ int function(char *a)
----end example code------ ----end example code------
Add <function_name>.o in the right alphabetically sorted place Add <function_name>.o in the right alphabetically sorted place
in libbb/Kbuild. You should look at the conditional part of in libbb/Kbuild.src. You should look at the conditional part of
libbb/Kbuild aswell. libbb/Kbuild.src as well.
You should also try to find a suitable place in include/libbb.h for You should also try to find a suitable place in include/libbb.h for
the function declaration. If not, add it somewhere anyway, with or without the function declaration. If not, add it somewhere anyway, with or without
ifdefs to include or not. ifdefs to include or not.
You can look at libbb/Config.in and try to find out if the function is You can look at libbb/Config.src and try to find out if the function is
tunable and add it there if it is. tunable and add it there if it is.
@ -118,11 +118,11 @@ Find the appropriate directory for your new applet.
Make sure you find the appropriate places in the files, the applets are Make sure you find the appropriate places in the files, the applets are
sorted alphabetically. sorted alphabetically.
Add the applet to Kbuild in the chosen directory: Add the applet to Kbuild.src in the chosen directory:
lib-$(CONFIG_MU) += mu.o lib-$(CONFIG_MU) += mu.o
Add the applet to Config.in in the chosen directory: Add the applet to Config.src in the chosen directory:
config MU config MU
bool "MU" bool "MU"
@ -134,7 +134,7 @@ config MU
Usage String(s) Usage String(s)
--------------- ---------------
Next, add usage information for you applet to include/usage.h. Next, add usage information for you applet to include/usage.src.h.
This should look like the following: This should look like the following:
#define mu_trivial_usage \ #define mu_trivial_usage \
@ -149,17 +149,17 @@ This should look like the following:
If your program supports flags, the flags should be mentioned on the first If your program supports flags, the flags should be mentioned on the first
line (-[abcde]) and a detailed description of each flag should go in the line (-[abcde]) and a detailed description of each flag should go in the
mu_full_usage section, one flag per line. (Numerous examples of this mu_full_usage section, one flag per line. (Numerous examples of this
currently exist in usage.h.) currently exist in usage.src.h.)
Header Files Header Files
------------ ------------
Next, add an entry to include/applets.h. Be *sure* to keep the list Next, add an entry to include/applets.src.h. Be *sure* to keep the list
in alphabetical order, or else it will break the binary-search lookup 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: algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily:
Be sure to read the top of applets.h before adding your applet. Be sure to read the top of applets.src.h before adding your applet.
/* all programs above here are alphabetically "less than" 'mu' */ /* all programs above here are alphabetically "less than" 'mu' */
IF_MU(APPLET(mu, _BB_DIR_USR_BIN, _BB_SUID_DROP)) IF_MU(APPLET(mu, _BB_DIR_USR_BIN, _BB_SUID_DROP))