diff options
| author | kraai <kraai@69ca8d6d-28ef-0310-b511-8ec308f3f277> | 2002-03-18 16:03:00 +0000 |
|---|---|---|
| committer | kraai <kraai@69ca8d6d-28ef-0310-b511-8ec308f3f277> | 2002-03-18 16:03:00 +0000 |
| commit | 98cf973dea5a5f006f2c8f795233c461265d0513 (patch) | |
| tree | 921abf313924ce625f32fb3da90359ed2677d8a9 /docs | |
| parent | db175ba7deb10680c924dcfc0492479ab045ed44 (diff) | |
| download | busybox-w32-98cf973dea5a5f006f2c8f795233c461265d0513.tar.gz busybox-w32-98cf973dea5a5f006f2c8f795233c461265d0513.tar.bz2 busybox-w32-98cf973dea5a5f006f2c8f795233c461265d0513.zip | |
Thomas Lundquist
* docs/new-applet-HOWTO.txt: Update for new directory structure.
git-svn-id: svn://busybox.net/trunk/busybox@4408 69ca8d6d-28ef-0310-b511-8ec308f3f277
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/new-applet-HOWTO.txt | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt index edf7eeee8..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. | |||
| 6 | Credits: | 6 | Credits: |
| 7 | Matt Kraai - initial writeup | 7 | Matt Kraai - initial writeup |
| 8 | Mark Whitley - the remix | 8 | Mark Whitley - the remix |
| 9 | 9 | Thomas Lundquist - Added stuff for the new directory layout. | |
| 10 | 10 | ||
| 11 | Initial Write | 11 | Initial Write |
| 12 | ------------- | 12 | ------------- |
| @@ -81,11 +81,25 @@ program that could be useful in another program, consider putting them in | |||
| 81 | libbb. | 81 | libbb. |
| 82 | 82 | ||
| 83 | 83 | ||
| 84 | Placement / Directory | ||
| 85 | --------------------- | ||
| 86 | |||
| 87 | Find the appropriate directory for your new applet. | ||
| 88 | |||
| 89 | Add the applet to the applet directory Makefile: | ||
| 90 | |||
| 91 | obj-$(CONFIG_MU) += mu.o | ||
| 92 | |||
| 93 | Add the applet to the applet directory config.in: | ||
| 94 | |||
| 95 | bool 'mu' CONFIG_MU | ||
| 96 | |||
| 97 | |||
| 84 | Usage String(s) | 98 | Usage String(s) |
| 85 | --------------- | 99 | --------------- |
| 86 | 100 | ||
| 87 | Next, add usage information for you applet to usage.h. This should look like | 101 | Next, add usage information for you applet to include/usage.h. |
| 88 | the following: | 102 | This should look like the following: |
| 89 | 103 | ||
| 90 | #define mu_trivial_usage \ | 104 | #define mu_trivial_usage \ |
| 91 | "-[abcde] FILES" | 105 | "-[abcde] FILES" |
| @@ -104,9 +118,9 @@ currently exist in usage.h.) | |||
| 104 | Header Files | 118 | Header Files |
| 105 | ------------ | 119 | ------------ |
| 106 | 120 | ||
| 107 | Next, add an entry to applets.h. Be *sure* to keep the list in alphabetical | 121 | Next, add an entry to include/applets.h. Be *sure* to keep the list |
| 108 | order, or else it will break the binary-search lookup algorithm in busybox.c | 122 | in alphabetical order, or else it will break the binary-search lookup |
| 109 | and the Gods of BusyBox smite you. Yea, verily: | 123 | algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily: |
| 110 | 124 | ||
| 111 | /* all programs above here are alphabetically "less than" 'mu' */ | 125 | /* all programs above here are alphabetically "less than" 'mu' */ |
| 112 | #ifdef CONFIG_MU | 126 | #ifdef CONFIG_MU |
| @@ -126,6 +140,8 @@ Documentation | |||
| 126 | If you're feeling especially nice, you should also document your applet in the | 140 | If you're feeling especially nice, you should also document your applet in the |
| 127 | docs directory (but nobody ever does that). | 141 | docs directory (but nobody ever does that). |
| 128 | 142 | ||
| 143 | Adding some text to docs/Configure.help is a nice start. | ||
| 144 | |||
| 129 | 145 | ||
| 130 | The Grand Announcement | 146 | The Grand Announcement |
| 131 | ---------------------- | 147 | ---------------------- |
