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

docs/new-applet-HOWTO.txt: tweak a bit

Browse Source 
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
This commit is contained in:
Denys Vlasenko 2014-03-17 15:06:29 +01:00
parent c50493854a
commit f332617fbd
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -6,7 +6,7 @@ This document details the steps you must take to add a new applet to BusyBox.
Credits: Credits:
Matt Kraai - initial writeup Matt Kraai - initial writeup
Mark Whitley - the remix Mark Whitley - the remix
Thomas Lundquist - Trying to keep it updated. Thomas Lundquist - trying to keep it updated
When doing this you should consider using the latest git HEAD. When doing this you should consider using the latest git HEAD.
This is a good thing if you plan to getting it committed into mainline. This is a good thing if you plan to getting it committed into mainline.
@ -23,7 +23,7 @@ as the first include file in your applet.
For a new applet mu, here is the code that would go in mu.c: For a new applet mu, here is the code that would go in mu.c:
(busybox.h already includes most usual header files. You do not need (libbb.h already includes most usual header files. You do not need
#include <stdio.h> etc...) #include <stdio.h> etc...)
@ -43,7 +43,7 @@ For a new applet mu, here is the code that would go in mu.c:
//config:config MU //config:config MU
//config: bool "MU" //config: bool "MU"
//config: default n //config: default y
//config: help //config: help
//config: Returns an indeterminate value. //config: Returns an indeterminate value.
@ -51,12 +51,11 @@ For a new applet mu, here is the code that would go in mu.c:
//applet:IF_MU(APPLET(mu, BB_DIR_USR_BIN, BB_SUID_DROP)) //applet:IF_MU(APPLET(mu, BB_DIR_USR_BIN, BB_SUID_DROP))
//usage:#define mu_trivial_usage //usage:#define mu_trivial_usage
//usage: "-[abcde] FILES" //usage: "[-abcde] FILE..."
//usage:#define mu_full_usage //usage:#define mu_full_usage
//usage: "Returns an indeterminate value.\n\n" //usage: "Returns an indeterminate value\n"
//usage: "Options:\n" //usage: "\n -a First function"
//usage: "\t-a\t\tfirst function\n" //usage: "\n -b Second function"
//usage: "\t-b\t\tsecond function\n"
int mu_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; int mu_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
int mu_main(int argc, char **argv) int mu_main(int argc, char **argv)
@ -156,7 +155,7 @@ Add the config snippet to the .c file:
//config:config MU //config:config MU
//config: bool "MU" //config: bool "MU"
//config: default n //config: default y
//config: help //config: help
//config: Returns an indeterminate value. //config: Returns an indeterminate value.
@ -168,18 +167,16 @@ Next, add usage information for your applet to the .c file.
This should look like the following: This should look like the following:
//usage:#define mu_trivial_usage //usage:#define mu_trivial_usage
//usage: "-[abcde] FILES" //usage: "[-abcde] FILE..."
//usage:#define mu_full_usage //usage:#define mu_full_usage
//usage: "Returns an indeterminate value.\n\n" //usage: "Returns an indeterminate value\n"
//usage: "Options:\n" //usage: "\n -a First function"
//usage: "\t-a\t\tfirst function\n" //usage: "\n -b Second function"
//usage: "\t-b\t\tsecond function\n"
//usage: ... //usage: ...
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.
currently exist in usage.src.h.)
Header Files Header Files