diff options
author | Mike Frysinger <vapier@gentoo.org> | 2005-09-02 23:06:30 +0000 |
---|---|---|
committer | Mike Frysinger <vapier@gentoo.org> | 2005-09-02 23:06:30 +0000 |
commit | 9754b91c16288fd0f4d6301fd6d01aa8b3c3b1d9 (patch) | |
tree | d59686d3aceca098b3010cc59b08d269efe7189e /docs/new-applet-HOWTO.txt | |
parent | f46f1b4d8a6effe99975aa6960bb865511712cab (diff) | |
download | busybox-w32-9754b91c16288fd0f4d6301fd6d01aa8b3c3b1d9.tar.gz busybox-w32-9754b91c16288fd0f4d6301fd6d01aa8b3c3b1d9.tar.bz2 busybox-w32-9754b91c16288fd0f4d6301fd6d01aa8b3c3b1d9.zip |
touchup some grammar, formatting, and remove some outdated notes
Diffstat (limited to 'docs/new-applet-HOWTO.txt')
-rw-r--r-- | docs/new-applet-HOWTO.txt | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/docs/new-applet-HOWTO.txt b/docs/new-applet-HOWTO.txt index 605974c3a..24bc1d824 100644 --- a/docs/new-applet-HOWTO.txt +++ b/docs/new-applet-HOWTO.txt | |||
@@ -11,10 +11,11 @@ Thomas Lundquist - Added stuff for the new directory layout. | |||
11 | Initial Write | 11 | Initial Write |
12 | ------------- | 12 | ------------- |
13 | 13 | ||
14 | First, write your applet. Be sure to include copyright information at the | 14 | First, write your applet. Be sure to include copyright information at the top, |
15 | top, such as who you stole the code from and so forth. Also include the | 15 | such as who you stole the code from and so forth. Also include the mini-GPL |
16 | mini-GPL boilerplate. Be sure to name the main function <applet>_main instead | 16 | boilerplate. Be sure to name the main function <applet>_main instead of main. |
17 | of main. And be sure to put it in <applet>.c. Usage do not have to be taken care of by your applet. | 17 | And be sure to put it in <applet>.c. Usage does not have to be taken care of by |
18 | your applet. | ||
18 | 19 | ||
19 | For a new applet mu, here is the code that would go in mu.c: | 20 | For a new applet mu, here is the code that would go in mu.c: |
20 | 21 | ||
@@ -78,8 +79,7 @@ As you are writing your applet, please be aware of the body of pre-existing | |||
78 | useful functions in libbb. Use these instead of reinventing the wheel. | 79 | useful functions in libbb. Use these instead of reinventing the wheel. |
79 | 80 | ||
80 | Additionally, if you have any useful, general-purpose functions in your | 81 | Additionally, if you have any useful, general-purpose functions in your |
81 | program that could be useful in another program, consider putting them in | 82 | applet that could be useful in other applets, consider putting them in libbb. |
82 | libbb. | ||
83 | 83 | ||
84 | 84 | ||
85 | Placement / Directory | 85 | Placement / Directory |
@@ -90,11 +90,11 @@ Find the appropriate directory for your new applet. | |||
90 | Make sure you find the appropriate places in the files, the applets are | 90 | Make sure you find the appropriate places in the files, the applets are |
91 | sorted alphabetically. | 91 | sorted alphabetically. |
92 | 92 | ||
93 | Add the applet to Makefile.in in the chosen applet directory: | 93 | Add the applet to Makefile.in in the chosen directory: |
94 | 94 | ||
95 | obj-$(CONFIG_MU) += mu.o | 95 | obj-$(CONFIG_MU) += mu.o |
96 | 96 | ||
97 | Add the applet to Config.in in the chosen applet directory: | 97 | Add the applet to Config.in in the chosen directory: |
98 | 98 | ||
99 | config CONFIG_MU | 99 | config CONFIG_MU |
100 | bool "MU" | 100 | bool "MU" |
@@ -116,6 +116,7 @@ This should look like the following: | |||
116 | "Options:\n" \ | 116 | "Options:\n" \ |
117 | "\t-a\t\tfirst function\n" \ | 117 | "\t-a\t\tfirst function\n" \ |
118 | "\t-b\t\tsecond function\n" \ | 118 | "\t-b\t\tsecond function\n" \ |
119 | ... | ||
119 | 120 | ||
120 | If your program supports flags, the flags should be mentioned on the first | 121 | If your program supports flags, the flags should be mentioned on the first |
121 | line (-[abcde]) and a detailed description of each flag should go in the | 122 | line (-[abcde]) and a detailed description of each flag should go in the |
@@ -149,10 +150,14 @@ Adding some text to docs/Configure.help is a nice start. | |||
149 | The Grand Announcement | 150 | The Grand Announcement |
150 | ---------------------- | 151 | ---------------------- |
151 | 152 | ||
152 | Then create a diff -urN of the files you added (<appletdir/><applet>.c, | 153 | Then create a diff -urN of the files you added and/or modified. Typically: |
153 | include/usage.c, include/applets.h, include/config.h, <appletdir>/Makefile.in, <appletdir>/config.in) | 154 | <appletdir>/<applet>.c |
155 | include/usage.c | ||
156 | include/applets.h | ||
157 | <appletdir>/Makefile.in | ||
158 | <appletdir>/config.in | ||
154 | and send it to the mailing list: | 159 | and send it to the mailing list: |
155 | busybox@busybox.net. | 160 | busybox@busybox.net |
161 | http://busybox.net/mailman/listinfo/busybox | ||
156 | 162 | ||
157 | Sending patches as attachments is preferred, but not required. | 163 | Sending patches as attachments is preferred, but not required. |
158 | |||