emo/busybox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

touchup some grammar, formatting, and remove some outdated notes

Browse Source
This commit is contained in:
Mike Frysinger 2005-09-02 23:06:30 +00:00
parent f46f1b4d8a
commit 9754b91c16
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/new-applet-HOWTO.txt
View File

@ -11,10 +11,11 @@ Thomas Lundquist - Added stuff for the new directory layout.
Initial Write Initial Write
------------- -------------
First, write your applet. Be sure to include copyright information at the First, write your applet. Be sure to include copyright information at the top,
top, such as who you stole the code from and so forth. Also include the such as who you stole the code from and so forth. Also include the mini-GPL
mini-GPL boilerplate. Be sure to name the main function <applet>_main instead boilerplate. Be sure to name the main function <applet>_main instead of main.
of main. And be sure to put it in <applet>.c. Usage do not have to be taken care of by your applet. And be sure to put it in <applet>.c. Usage does not have to be taken care of by
your applet.
For a new applet mu, here is the code that would go in mu.c: For a new applet mu, here is the code that would go in mu.c:
@ -78,8 +79,7 @@ As you are writing your applet, please be aware of the body of pre-existing
useful functions in libbb. Use these instead of reinventing the wheel. useful functions in libbb. Use these instead of reinventing the wheel.
Additionally, if you have any useful, general-purpose functions in your Additionally, if you have any useful, general-purpose functions in your
program that could be useful in another program, consider putting them in applet that could be useful in other applets, consider putting them in libbb.
libbb.
Placement / Directory Placement / Directory
@ -90,11 +90,11 @@ Find the appropriate directory for your new applet.
Make sure you find the appropriate places in the files, the applets are Make sure you find the appropriate places in the files, the applets are
sorted alphabetically. sorted alphabetically.
Add the applet to Makefile.in in the chosen applet directory: Add the applet to Makefile.in in the chosen directory:
obj-$(CONFIG_MU) += mu.o obj-$(CONFIG_MU) += mu.o
Add the applet to Config.in in the chosen applet directory: Add the applet to Config.in in the chosen directory:
config CONFIG_MU config CONFIG_MU
bool "MU" bool "MU"
@ -116,6 +116,7 @@ This should look like the following:
"Options:\n" \ "Options:\n" \
"\t-a\t\tfirst function\n" \ "\t-a\t\tfirst function\n" \
"\t-b\t\tsecond function\n" \ "\t-b\t\tsecond function\n" \
...
If your program supports flags, the flags should be mentioned on the first If your program supports flags, the flags should be mentioned on the first
line (-[abcde]) and a detailed description of each flag should go in the 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.
The Grand Announcement The Grand Announcement
---------------------- ----------------------
Then create a diff -urN of the files you added (<appletdir/><applet>.c, Then create a diff -urN of the files you added and/or modified. Typically:
include/usage.c, include/applets.h, include/config.h, <appletdir>/Makefile.in, <appletdir>/config.in) <appletdir>/<applet>.c
include/usage.c
include/applets.h
<appletdir>/Makefile.in
<appletdir>/config.in
and send it to the mailing list: and send it to the mailing list:
busybox@busybox.net. busybox@busybox.net
http://busybox.net/mailman/listinfo/busybox
Sending patches as attachments is preferred, but not required. Sending patches as attachments is preferred, but not required.