aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDenys Vlasenko <vda.linux@googlemail.com>2009-06-03 15:19:03 +0200
committerDenys Vlasenko <vda.linux@googlemail.com>2009-06-03 15:19:03 +0200
commitdc2bbb9669e53e70965dd09469f5ea701dc3d4ba (patch)
treee876bd20e57394166441f2a6ab7f8acfd4b8b45c /docs
parent08218013499f76e61691d5ffa697465f800bd3a7 (diff)
downloadbusybox-w32-dc2bbb9669e53e70965dd09469f5ea701dc3d4ba.tar.gz
busybox-w32-dc2bbb9669e53e70965dd09469f5ea701dc3d4ba.tar.bz2
busybox-w32-dc2bbb9669e53e70965dd09469f5ea701dc3d4ba.zip
tweak docs
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.txt37
1 files changed, 9 insertions, 28 deletions
diff --git a/docs/contributing.txt b/docs/contributing.txt
index aad43035c..54cba750e 100644
--- a/docs/contributing.txt
+++ b/docs/contributing.txt
@@ -17,19 +17,18 @@ help. However, before you dive in, headlong and hotfoot, there are some things
17you need to do: 17you need to do:
18 18
19 19
20Checkout the Latest Code from CVS 20Checkout the Latest Code
21~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 21~~~~~~~~~~~~~~~~~~~~~~~~
22 22
23This is a necessary first step. Please do not try to work with the last 23This is a necessary first step. Please do not try to work with the last
24released version, as there is a good chance that somebody has already fixed 24released version, as there is a good chance that somebody has already fixed
25the bug you found. Somebody might have even added the feature you had in mind. 25the bug you found. Somebody might have even added the feature you had in mind.
26Don't make your work obsolete before you start! 26Don't make your work obsolete before you start!
27 27
28For information on how to check out Busybox from CVS, please look at the 28For information on how to check out Busybox development tree, please look at the
29following links: 29following links:
30 30
31 http://busybox.net/cvs_anon.html 31 http://busybox.net/source.html
32 http://busybox.net/cvs_howto.html
33 32
34 33
35Read the Mailing List 34Read the Mailing List
@@ -87,14 +86,10 @@ Knife" of embedded Linux, there are some applets that will not be accepted:
87 we do not want to start adding mkfs/fsck tools for every (or any) 86 we do not want to start adding mkfs/fsck tools for every (or any)
88 filesystem under the sun. (fsck_minix.c and mkfs_minix.c are living on 87 filesystem under the sun. (fsck_minix.c and mkfs_minix.c are living on
89 borrowed time.) There are far too many of these tools out there. Use 88 borrowed time.) There are far too many of these tools out there. Use
90 the upstream version. Not everything has to be part of Busybox. 89 the upstream version. Rationale: bugs in these tools can destroy
91 90 vast amounts of data. Keeping up with filesystem format development
92 - Any partitioning tools: Partitioning a device is typically done once and 91 is impractical (especially in the area of keeping fsck tool safe
93 only once, and tools which do this generally do not need to reside on the 92 and up-to-date).
94 target device (esp a flash device). If you need a partitioning tool, grab
95 one (such as fdisk, sfdisk, or cfdisk from util-linux) and use that, but
96 don't try to merge it into busybox. These are nasty and complex and we
97 don't want to maintain them.
98 93
99 - Any disk, device, or media-specific tools: Use the -utils or -tools package 94 - Any disk, device, or media-specific tools: Use the -utils or -tools package
100 that was designed for your device; don't try to shoehorn them into Busybox. 95 that was designed for your device; don't try to shoehorn them into Busybox.
@@ -103,12 +98,6 @@ Knife" of embedded Linux, there are some applets that will not be accepted:
103 independent. Do not send us tools that cannot be used across multiple 98 independent. Do not send us tools that cannot be used across multiple
104 platforms / arches. 99 platforms / arches.
105 100
106 - Any daemons that are not essential to basic system operation. To date, only
107 syslogd and klogd meet this requirement. We do not need a web server, an
108 ftp daemon, a dhcp server, a mail transport agent or a dns resolver. If you
109 need one of those, you are welcome to ask the folks on the mailing list for
110 recommendations, but please don't bloat up Busybox with any of these.
111
112 101
113Bug Reporting 102Bug Reporting
114~~~~~~~~~~~~~ 103~~~~~~~~~~~~~
@@ -138,7 +127,7 @@ an example:
138 llegal instruction 127 llegal instruction
139 128
140 I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder, 129 I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder,
141 and the latest uClibc from CVS. Thanks for the wonderful program! 130 and the latest uClibc from CVS.
142 131
143 -Diligent 132 -Diligent
144 133
@@ -199,14 +188,6 @@ Janitorial Work
199 188
200These are dirty jobs, but somebody's gotta do 'em. 189These are dirty jobs, but somebody's gotta do 'em.
201 190
202 - Converting applets to use getopt() for option processing. Type 'find -name
203 '*.c'|grep -L getopt' to get a listing of the applets that currently don't
204 use getopt. If a .c file processes no options, it should have a line that
205 reads: /* no options, no getopt */ somewhere in the file.
206
207 - Replace any "naked" calls to malloc, calloc, realloc, str[n]dup, fopen with
208 the x* equivalents found in libbb/xfuncs.c.
209
210 - Security audits: 191 - Security audits:
211 http://www.securityfocus.com/popups/forums/secprog/intro.shtml 192 http://www.securityfocus.com/popups/forums/secprog/intro.shtml
212 193
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-17 00:35:40 +0000