diff options
| -rw-r--r-- | docs/new-applet-HOWTO.txt | 21 |
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) ----end example code------ + +Coding Style +------------ + +Before you submit your applet for inclusion in BusyBox, (or better yet, before +you _write_ your applet) please read through the style guide in the docs +directory and make your program compliant. + + +Some Words on utility.c +----------------------- + As you are writing your applet, please be aware of the body of pre-existing useful functions in utility.c. Use these instead of reinventing the wheel. + +If you use functions from utility.c, you may need to add to the preprocessor +conditionals in that file, to make sure the routines you need are included. +So, since your mu implementation used safe_read(), append "|| define BB_MU" to +the #if instruction that precedes the safe_read() function in utility.c . + Additionally, if you have any useful, general-purpose functions in your program that could be useful in another program, consider putting them in utility.c. -Furthermore, please read through the style guide in the docs directory and -make your program compliant. - Usage String(s) --------------- |