X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=docs%2Fnew-applet-HOWTO.txt;h=7cae30b457c4b81d7da2b2c49d9ec6fe2140245a;hb=008c01915b69b006da92b986dd6fea6edb3c3097;hp=1f5c3ebd5318e772d50f3d423ee129394e4a4ca9;hpb=2e6d3cfa82eb64fffe53ccb5669aa7146228cf8f;p=oweals%2Fbusybox.git diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt index 1f5c3ebd5..7cae30b45 100644 --- a/docs/new-applet-HOWTO.txt +++ b/docs/new-applet-HOWTO.txt @@ -6,7 +6,7 @@ This document details the steps you must take to add a new applet to BusyBox. Credits: Matt Kraai - initial writeup Mark Whitley - the remix - +Thomas Lundquist - Added stuff for the new directory layout. Initial Write ------------- @@ -81,11 +81,25 @@ program that could be useful in another program, consider putting them in libbb. +Placement / Directory +--------------------- + +Find the appropriate directory for your new applet. + +Add the applet to the applet directory Makefile: + +obj-$(CONFIG_MU) += mu.o + +Add the applet to the applet directory config.in: + +bool 'mu' CONFIG_MU + + Usage String(s) --------------- -Next, add usage information for you applet to usage.h. This should look like -the following: +Next, add usage information for you applet to include/usage.h. +This should look like the following: #define mu_trivial_usage \ "-[abcde] FILES" @@ -104,12 +118,12 @@ currently exist in usage.h.) Header Files ------------ -Next, add an entry to applets.h. Be *sure* to keep the list 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: +Next, add an entry to include/applets.h. Be *sure* to keep the list +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: /* all programs above here are alphabetically "less than" 'mu' */ - #ifdef BB_MU + #ifdef CONFIG_MU APPLET("mu", mu_main, _BB_DIR_USR_BIN, mu_usage) #endif /* all programs below here are alphabetically "greater than" 'mu' */ @@ -117,7 +131,7 @@ and the Gods of BusyBox smite you. Yea, verily: Finally, add a define for your applet to Config.h: - #define BB_MU + #define CONFIG_MU Documentation @@ -126,13 +140,15 @@ Documentation If you're feeling especially nice, you should also document your applet in the docs directory (but nobody ever does that). +Adding some text to docs/Configure.help is a nice start. + The Grand Announcement ---------------------- Then create a diff -urN of the files you added (.c, usage.c, applets.h, Config.h) and send it to the mailing list: -busybox@opensource.lineo.com. Sending patches as attachments is preferred, but +busybox@busybox.net. Sending patches as attachments is preferred, but not required.