aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/new-applet-HOWTO.txt21
1 files changed, 18 insertions, 3 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt
index c27aef828..638526a0c 100644
--- a/docs/new-applet-HOWTO.txt
+++ b/docs/new-applet-HOWTO.txt
@@ -61,15 +61,30 @@ int mu_main(int argc, char **argv)
61 61
62----end example code------ 62----end example code------
63 63
64
65Coding Style
66------------
67
68Before you submit your applet for inclusion in BusyBox, (or better yet, before
69you _write_ your applet) please read through the style guide in the docs
70directory and make your program compliant.
71
72
73Some Words on utility.c
74-----------------------
75
64As you are writing your applet, please be aware of the body of pre-existing 76As you are writing your applet, please be aware of the body of pre-existing
65useful functions in utility.c. Use these instead of reinventing the wheel. 77useful functions in utility.c. Use these instead of reinventing the wheel.
78
79If you use functions from utility.c, you may need to add to the preprocessor
80conditionals in that file, to make sure the routines you need are included.
81So, since your mu implementation used safe_read(), append "|| define BB_MU" to
82the #if instruction that precedes the safe_read() function in utility.c .
83
66Additionally, if you have any useful, general-purpose functions in your 84Additionally, if you have any useful, general-purpose functions in your
67program that could be useful in another program, consider putting them in 85program that could be useful in another program, consider putting them in
68utility.c. 86utility.c.
69 87
70Furthermore, please read through the style guide in the docs directory and
71make your program compliant.
72
73 88
74Usage String(s) 89Usage String(s)
75--------------- 90---------------