aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorandersen <andersen@69ca8d6d-28ef-0310-b511-8ec308f3f277>2003-07-14 21:21:08 +0000
committerandersen <andersen@69ca8d6d-28ef-0310-b511-8ec308f3f277>2003-07-14 21:21:08 +0000
commitad42ea5b0d506c6886eb87a4ff7f175598356cd3 (patch)
tree81fb6290ef50af3488a5ee0f97150b6503df6a3f /docs
parentc49e4634f9c92aae68e4345d18594a6b3920fcdf (diff)
downloadbusybox-w32-ad42ea5b0d506c6886eb87a4ff7f175598356cd3.tar.gz
busybox-w32-ad42ea5b0d506c6886eb87a4ff7f175598356cd3.tar.bz2
busybox-w32-ad42ea5b0d506c6886eb87a4ff7f175598356cd3.zip
Update a bunch of docs. Run a script to update my email addr.
git-svn-id: svn://busybox.net/trunk/busybox@7061 69ca8d6d-28ef-0310-b511-8ec308f3f277
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/autodocifier.pl6
-rw-r--r--docs/busybox.net/index.html5
-rw-r--r--docs/busybox.sgml8
-rw-r--r--docs/busybox_footer.pod10
-rw-r--r--docs/contributing.txt75
5 files changed, 36 insertions, 68 deletions
diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl
index 377c8b55b..e06a1dad8 100755
--- a/docs/autodocifier.pl
+++ b/docs/autodocifier.pl
@@ -197,8 +197,8 @@ machine-readable form, and scripts could be used to transform this
197text into other forms if necessary. 197text into other forms if necessary.
198 198
199F<autodocifier.pl> is one such script. 199F<autodocifier.pl> is one such script.
200It was based on a script by Erik Andersen <andersen@lineo.com> 200It was based on a script by Erik Andersen <andersen@codepoet.org>
201which was in turn based on a script by Mark Whitley <markw@lineo.com> 201which was in turn based on a script by Mark Whitley <markw@codepoet.org>
202 202
203=head1 OPTIONS 203=head1 OPTIONS
204 204
@@ -288,4 +288,4 @@ John BEPPU <b@ax9.org>
288 288
289=cut 289=cut
290 290
291# $Id: autodocifier.pl,v 1.23 2001/10/31 04:29:18 beppu Exp $ 291# $Id: autodocifier.pl,v 1.24 2003/07/14 21:20:48 andersen Exp $
diff --git a/docs/busybox.net/index.html b/docs/busybox.net/index.html
index 79d675471..c4a49d2fe 100644
--- a/docs/busybox.net/index.html
+++ b/docs/busybox.net/index.html
@@ -274,11 +274,6 @@
274 the README file included in the busybox source 274 the README file included in the busybox source
275 release.</li> 275 release.</li>
276 276
277 <li><a href=
278 "http://bugs.busybox.net/db/pa/lbusybox.html">BusyBox
279 Bugs</a>. Need to report a bug? Need to check if a
280 bug has been filed?</li>
281
282 <li>If you need more help, the BusyBox <a href= 277 <li>If you need more help, the BusyBox <a href=
283 "lists/busybox/">mailing list</a> is a good place to 278 "lists/busybox/">mailing list</a> is a good place to
284 start.</li> 279 start.</li>
diff --git a/docs/busybox.sgml b/docs/busybox.sgml
index dacc13249..f1d42b6b5 100644
--- a/docs/busybox.sgml
+++ b/docs/busybox.sgml
@@ -3913,7 +3913,7 @@
3913 <title>MAINTAINER</title> 3913 <title>MAINTAINER</title>
3914 3914
3915 <para> 3915 <para>
3916 Erik Andersen &lt;andersee@debian.org&gt; &lt;andersen@lineo.com&gt; 3916 Erik Andersen &lt;andersen@codepoet.org&gt;
3917 </para> 3917 </para>
3918 </chapter> 3918 </chapter>
3919 3919
@@ -3926,7 +3926,7 @@
3926 </para> 3926 </para>
3927 3927
3928 <para> 3928 <para>
3929 Erik Andersen &lt;andersee@debian.org&gt; 3929 Erik Andersen &lt;andersen@codepoet.org&gt;
3930 </para> 3930 </para>
3931 3931
3932 <para> 3932 <para>
@@ -3934,7 +3934,7 @@
3934 </para> 3934 </para>
3935 3935
3936 <para> 3936 <para>
3937 John Beppu &lt;beppu@lineo.com&gt; 3937 John Beppu &lt;beppu@codepoet.org&gt;
3938 </para> 3938 </para>
3939 3939
3940 <para> 3940 <para>
@@ -3990,7 +3990,7 @@
3990 </para> 3990 </para>
3991 3991
3992 <para> 3992 <para>
3993 Mark Whitley &lt;markw@lineo.com&gt; 3993 Mark Whitley &lt;markw@codepoet.org&gt;
3994 </para> 3994 </para>
3995 3995
3996 <para> 3996 <para>
diff --git a/docs/busybox_footer.pod b/docs/busybox_footer.pod
index f74e4ae6c..0fc29f4c4 100644
--- a/docs/busybox_footer.pod
+++ b/docs/busybox_footer.pod
@@ -20,7 +20,7 @@ textutils(1), shellutils(1), etc...
20 20
21=head1 MAINTAINER 21=head1 MAINTAINER
22 22
23Erik Andersen <andersee@debian.org> <andersen@lineo.com> 23Erik Andersen <andersen@codepoet.org>
24 24
25=head1 AUTHORS 25=head1 AUTHORS
26 26
@@ -30,14 +30,14 @@ they know it or not.
30 30
31=for html <br> 31=for html <br>
32 32
33Erik Andersen <andersen@lineo.com>, <andersee@debian.org> 33Erik Andersen <andersen@codepoet.org>
34 34
35 Tons of new stuff, major rewrite of most of the 35 Tons of new stuff, major rewrite of most of the
36 core apps, tons of new apps as noted in header files. 36 core apps, tons of new apps as noted in header files.
37 37
38=for html <br> 38=for html <br>
39 39
40John Beppu <beppu@lineo.com> 40John Beppu <beppu@codepoet.org>
41 41
42 du, head, nslookup, sort, tee, uniq (so Kraai could rewrite them ;-), 42 du, head, nslookup, sort, tee, uniq (so Kraai could rewrite them ;-),
43 documentation 43 documentation
@@ -150,7 +150,7 @@ Linus Torvalds <torvalds@transmeta.com>
150 150
151=for html <br> 151=for html <br>
152 152
153Mark Whitley <markw@lineo.com> 153Mark Whitley <markw@codepoet.org>
154 154
155 sed remix, bug fixes, style-guide, etc. 155 sed remix, bug fixes, style-guide, etc.
156 156
@@ -174,4 +174,4 @@ Glenn Engel <glenne@engel.org>
174 174
175=cut 175=cut
176 176
177# $Id: busybox_footer.pod,v 1.11 2003/02/10 22:53:36 bug1 Exp $ 177# $Id: busybox_footer.pod,v 1.12 2003/07/14 21:20:48 andersen Exp $
diff --git a/docs/contributing.txt b/docs/contributing.txt
index c1e3f3803..bf6dedfe8 100644
--- a/docs/contributing.txt
+++ b/docs/contributing.txt
@@ -113,45 +113,39 @@ Knife" of embedded Linux, there are some applets that will not be accepted:
113Bug Reporting 113Bug Reporting
114~~~~~~~~~~~~~ 114~~~~~~~~~~~~~
115 115
116If you find a bug in Busybox, you can send a bug report to our bug tracking 116If you find bugs, please submit a detailed bug report to the busybox mailing
117system (homepage: http://bugs.lineo.com). Instructions on how to send a bug 117list at busybox@busybox.net. A well-written bug report should include a
118report to the tracking system can be found at: 118transcript of a shell session that demonstrates the bad behavior and enables
119anyone else to duplicate the bug on their own machine. The following is such
120an example:
119 121
120 http://bugs.lineo.com/Reporting.html 122 To: busybox@busybox.net
121 123 From: diligent@testing.linux.org
122The README file that comes with Busybox also describes how to submit a bug. 124 Subject: /bin/date doesn't work
123 125
124A well-written bug report should include a transcript of a shell session that 126 Package: busybox
125demonstrates the bad behavior and enables anyone else to duplicate the bug on 127 Version: 1.00
126their own machine. The following is such an example:
127 128
128 When I execute Busybox 'date' it produces unexpected results. 129 When I execute Busybox 'date' it produces unexpected results.
130 With GNU date I get the following output:
129 131
130 This is using GNU date:
131 $ date 132 $ date
132 Wed Mar 21 14:19:41 MST 2001 133 Wed Mar 21 14:19:41 MST 2001
133 134
134 This is using Busybox date: 135 But when I use BusyBox date I get this instead:
135 $ date
136 codswaddle
137
138 136
139Bug Triage 137 $ date
140~~~~~~~~~~ 138 llegal instruction
141 139
142Validating and confirming bugs is nearly as important as reporting them in the 140 I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder,
143first place. It is valuable to know if a bug can be duplicated on a different 141 and the latest uClibc from CVS. Thanks for the wonderful program!
144machine, on a different filesystem, on a different architecture, with a
145different C library, and so forth.
146 142
147To see a listing of all the bugs currently filed against Busybox, look here: 143 -Diligent
148 144
149 http://bugs.lineo.com/db/pa/lbusybox.html 145Note the careful description and use of examples showing not only what BusyBox
146does, but also a counter example showing what an equivalent GNU app does. Bug
147reports lacking such detail may never be fixed... Thanks for understanding.
150 148
151If you have comments to add to a bug (can / can't duplicate, think a bug
152should be closed / reopened), please send it to [bugnumber]@bugs.lineo.com.
153The message you send will automatically be forwarded to the mailing list for
154all to see.
155 149
156 150
157Write Documentation 151Write Documentation
@@ -183,16 +177,6 @@ This will show all of the trouble spots or 'questionable' code. Pick a spot,
183any spot, these are all invitations for you to contribute. 177any spot, these are all invitations for you to contribute.
184 178
185 179
186Consult The Bug-Tracking System
187~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
188
189Head to: http://bugs.lineo.com/db/pa/lBusybox.html and look at the bugs on
190there. Pick one you think you can fix, and fix it. If it's a wishlist item and
191someone's requesting a new feature, take a stab at adding it. Everything
192previously said about "reading the mailing list" and "coordinating with the
193applet maintainer" still applies.
194
195
196Add a New Applet 180Add a New Applet
197~~~~~~~~~~~~~~~~ 181~~~~~~~~~~~~~~~~
198 182
@@ -309,16 +293,15 @@ are some guidelines on how to test your changes.
309Making Sure Your Patch Doesn't Get Lost 293Making Sure Your Patch Doesn't Get Lost
310~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 294~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311 295
312If you don't want your patch to be lost or forgotten, send it to the bug 296If you don't want your patch to be lost or forgotten, send it to the busybox
313tracking system (http://bugs.lineo.com). You do this by emailing your patch in 297mailing list with a subject line something like this:
314a message to submit@bugs.lineo.com with a subject line something like this:
315 298
316 [PATCH] - Adds "transmogrify" feature to "foo" 299 [PATCH] - Adds "transmogrify" feature to "foo"
317 300
318In the body, you should have a pseudo-header that looks like the following: 301In the body, you should have a pseudo-header that looks like the following:
319 302
320 Package: busybox 303 Package: busybox
321 Version: v0.50pre (or whatever the current version is) 304 Version: v1.01pre (or whatever the current version is)
322 Severity: wishlist 305 Severity: wishlist
323 306
324The remainder of the body should read along these lines: 307The remainder of the body should read along these lines:
@@ -328,16 +311,6 @@ The remainder of the body should read along these lines:
328 GNU counterparts and the outputs are identical. I have run the scripts in 311 GNU counterparts and the outputs are identical. I have run the scripts in
329 the 'tests' directory and nothing breaks. 312 the 'tests' directory and nothing breaks.
330 313
331Detailed instructions on how to submit a bug to the tracking system are at:
332
333 http://bugs.lineo.com/Reporting.html
334
335If you have a patch that will fix and close a reported bug, please send a
336message to [bugnumber]@bugs.lineo.com with your patch attached. It will catch
337people's attention if you have a subject line like the following:
338
339 [PATCH INCLUDED] - Fix attached, please apply and close this bug
340
341 314
342 315
343Improving Your Chances of Patch Acceptance 316Improving Your Chances of Patch Acceptance
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-24 19:42:49 +0000