diff options
| author | Holger Blasum <hbl@sysgo.com> | 2010-10-28 20:37:05 +0200 |
|---|---|---|
| committer | Denys Vlasenko <vda.linux@googlemail.com> | 2010-10-28 20:37:05 +0200 |
| commit | b27d62af8bd83f482506271510bfa6e873b953ab (patch) | |
| tree | 37c8e1907d1dfb600634f55da3720353c05330f5 /docs | |
| parent | 756e95e7822182f0bb75fc33284123c9b73f3d8f (diff) | |
| download | busybox-w32-b27d62af8bd83f482506271510bfa6e873b953ab.tar.gz busybox-w32-b27d62af8bd83f482506271510bfa6e873b953ab.tar.bz2 busybox-w32-b27d62af8bd83f482506271510bfa6e873b953ab.zip | |
update docs/new-applet-HOWTO.txt
Signed-off-by: Holger Blasum <hbl@sysgo.com>
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/new-applet-HOWTO.txt | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt index 2f237564d..8a825b998 100644 --- a/docs/new-applet-HOWTO.txt +++ b/docs/new-applet-HOWTO.txt | |||
| @@ -99,14 +99,14 @@ int function(char *a) | |||
| 99 | ----end example code------ | 99 | ----end example code------ |
| 100 | 100 | ||
| 101 | Add <function_name>.o in the right alphabetically sorted place | 101 | Add <function_name>.o in the right alphabetically sorted place |
| 102 | in libbb/Kbuild. You should look at the conditional part of | 102 | in libbb/Kbuild.src. You should look at the conditional part of |
| 103 | libbb/Kbuild aswell. | 103 | libbb/Kbuild.src as well. |
| 104 | 104 | ||
| 105 | You should also try to find a suitable place in include/libbb.h for | 105 | You should also try to find a suitable place in include/libbb.h for |
| 106 | the function declaration. If not, add it somewhere anyway, with or without | 106 | the function declaration. If not, add it somewhere anyway, with or without |
| 107 | ifdefs to include or not. | 107 | ifdefs to include or not. |
| 108 | 108 | ||
| 109 | You can look at libbb/Config.in and try to find out if the function is | 109 | You can look at libbb/Config.src and try to find out if the function is |
| 110 | tunable and add it there if it is. | 110 | tunable and add it there if it is. |
| 111 | 111 | ||
| 112 | 112 | ||
| @@ -118,11 +118,11 @@ Find the appropriate directory for your new applet. | |||
| 118 | Make sure you find the appropriate places in the files, the applets are | 118 | Make sure you find the appropriate places in the files, the applets are |
| 119 | sorted alphabetically. | 119 | sorted alphabetically. |
| 120 | 120 | ||
| 121 | Add the applet to Kbuild in the chosen directory: | 121 | Add the applet to Kbuild.src in the chosen directory: |
| 122 | 122 | ||
| 123 | lib-$(CONFIG_MU) += mu.o | 123 | lib-$(CONFIG_MU) += mu.o |
| 124 | 124 | ||
| 125 | Add the applet to Config.in in the chosen directory: | 125 | Add the applet to Config.src in the chosen directory: |
| 126 | 126 | ||
| 127 | config MU | 127 | config MU |
| 128 | bool "MU" | 128 | bool "MU" |
| @@ -134,7 +134,7 @@ config MU | |||
| 134 | Usage String(s) | 134 | Usage String(s) |
| 135 | --------------- | 135 | --------------- |
| 136 | 136 | ||
| 137 | Next, add usage information for you applet to include/usage.h. | 137 | Next, add usage information for you applet to include/usage.src.h. |
| 138 | This should look like the following: | 138 | This should look like the following: |
| 139 | 139 | ||
| 140 | #define mu_trivial_usage \ | 140 | #define mu_trivial_usage \ |
| @@ -149,17 +149,17 @@ This should look like the following: | |||
| 149 | If your program supports flags, the flags should be mentioned on the first | 149 | If your program supports flags, the flags should be mentioned on the first |
| 150 | line (-[abcde]) and a detailed description of each flag should go in the | 150 | line (-[abcde]) and a detailed description of each flag should go in the |
| 151 | mu_full_usage section, one flag per line. (Numerous examples of this | 151 | mu_full_usage section, one flag per line. (Numerous examples of this |
| 152 | currently exist in usage.h.) | 152 | currently exist in usage.src.h.) |
| 153 | 153 | ||
| 154 | 154 | ||
| 155 | Header Files | 155 | Header Files |
| 156 | ------------ | 156 | ------------ |
| 157 | 157 | ||
| 158 | Next, add an entry to include/applets.h. Be *sure* to keep the list | 158 | Next, add an entry to include/applets.src.h. Be *sure* to keep the list |
| 159 | in alphabetical order, or else it will break the binary-search lookup | 159 | in alphabetical order, or else it will break the binary-search lookup |
| 160 | algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily: | 160 | algorithm in busybox.c and the Gods of BusyBox smite you. Yea, verily: |
| 161 | 161 | ||
| 162 | Be sure to read the top of applets.h before adding your applet. | 162 | Be sure to read the top of applets.src.h before adding your applet. |
| 163 | 163 | ||
| 164 | /* all programs above here are alphabetically "less than" 'mu' */ | 164 | /* all programs above here are alphabetically "less than" 'mu' */ |
| 165 | IF_MU(APPLET(mu, _BB_DIR_USR_BIN, _BB_SUID_DROP)) | 165 | IF_MU(APPLET(mu, _BB_DIR_USR_BIN, _BB_SUID_DROP)) |