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

Update a bunch of docs. Run a script to update my email addr.

Browse Source
This commit is contained in:
Eric Andersen
2003-07-14 21:21:08 +00:00
parent 74f270a317
commit cb81e6484d
169 changed files with 297 additions and 379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/autodocifier.pl
View File

@@ -197,8 +197,8 @@ machine-readable form, and scripts could be used to transform this
text into other forms if necessary.
F<autodocifier.pl> is one such script.
It was based on a script by Erik Andersen <andersen@lineo.com>
which was in turn based on a script by Mark Whitley <markw@lineo.com>
It was based on a script by Erik Andersen <andersen@codepoet.org>
which was in turn based on a script by Mark Whitley <markw@codepoet.org>
=head1 OPTIONS
@@ -288,4 +288,4 @@ John BEPPU <b@ax9.org>
=cut
# $Id: autodocifier.pl,v 1.23 2001/10/31 04:29:18 beppu Exp $
# $Id: autodocifier.pl,v 1.24 2003/07/14 21:20:48 andersen Exp $

5
docs/busybox.net/index.html
View File

@@ -274,11 +274,6 @@
the README file included in the busybox source
release.</li>
<li><a href=
"http://bugs.busybox.net/db/pa/lbusybox.html">BusyBox
Bugs</a>. Need to report a bug? Need to check if a
bug has been filed?</li>
<li>If you need more help, the BusyBox <a href=
"lists/busybox/">mailing list</a> is a good place to
start.</li>

8
docs/busybox.sgml
View File

@@ -3913,7 +3913,7 @@
<title>MAINTAINER</title>
<para>
Erik Andersen &lt;andersee@debian.org&gt; &lt;andersen@lineo.com&gt;
Erik Andersen &lt;andersen@codepoet.org&gt;
</para>
</chapter>
@@ -3926,7 +3926,7 @@
</para>
<para>
Erik Andersen &lt;andersee@debian.org&gt;
Erik Andersen &lt;andersen@codepoet.org&gt;
</para>
<para>
@@ -3934,7 +3934,7 @@
</para>
<para>
John Beppu &lt;beppu@lineo.com&gt;
John Beppu &lt;beppu@codepoet.org&gt;
</para>
<para>
@@ -3990,7 +3990,7 @@
</para>
<para>
Mark Whitley &lt;markw@lineo.com&gt;
Mark Whitley &lt;markw@codepoet.org&gt;
</para>
<para>

10
docs/busybox_footer.pod
View File

@@ -20,7 +20,7 @@ textutils(1), shellutils(1), etc...
=head1 MAINTAINER
Erik Andersen <andersee@debian.org> <andersen@lineo.com>
Erik Andersen <andersen@codepoet.org>
=head1 AUTHORS
@@ -30,14 +30,14 @@ they know it or not.
=for html <br>
Erik Andersen <andersen@lineo.com>, <andersee@debian.org>
Erik Andersen <andersen@codepoet.org>
Tons of new stuff, major rewrite of most of the
core apps, tons of new apps as noted in header files.
=for html <br>
John Beppu <beppu@lineo.com>
John Beppu <beppu@codepoet.org>
du, head, nslookup, sort, tee, uniq (so Kraai could rewrite them ;-),
documentation
@@ -150,7 +150,7 @@ Linus Torvalds <torvalds@transmeta.com>
=for html <br>
Mark Whitley <markw@lineo.com>
Mark Whitley <markw@codepoet.org>
sed remix, bug fixes, style-guide, etc.
@@ -174,4 +174,4 @@ Glenn Engel <glenne@engel.org>
=cut
# $Id: busybox_footer.pod,v 1.11 2003/02/10 22:53:36 bug1 Exp $
# $Id: busybox_footer.pod,v 1.12 2003/07/14 21:20:48 andersen Exp $

75
docs/contributing.txt
View File

@@ -113,45 +113,39 @@ Knife" of embedded Linux, there are some applets that will not be accepted:
Bug Reporting
~~~~~~~~~~~~~
If you find a bug in Busybox, you can send a bug report to our bug tracking
system (homepage: http://bugs.lineo.com). Instructions on how to send a bug
report to the tracking system can be found at:
If you find bugs, please submit a detailed bug report to the busybox mailing
list at busybox@busybox.net. A well-written bug report should include a
transcript of a shell session that demonstrates the bad behavior and enables
anyone else to duplicate the bug on their own machine. The following is such
an example:
http://bugs.lineo.com/Reporting.html
The README file that comes with Busybox also describes how to submit a bug.
To: busybox@busybox.net
From: diligent@testing.linux.org
Subject: /bin/date doesn't work
A well-written bug report should include a transcript of a shell session that
demonstrates the bad behavior and enables anyone else to duplicate the bug on
their own machine. The following is such an example:
Package: busybox
Version: 1.00
When I execute Busybox 'date' it produces unexpected results.
When I execute Busybox 'date' it produces unexpected results.
With GNU date I get the following output:
This is using GNU date:
$ date
Wed Mar 21 14:19:41 MST 2001
This is using Busybox date:
But when I use BusyBox date I get this instead:
$ date
codswaddle
llegal instruction
I am using Debian unstable, kernel version 2.4.19-rmk1 on an Netwinder,
and the latest uClibc from CVS. Thanks for the wonderful program!
Bug Triage
~~~~~~~~~~
-Diligent
Validating and confirming bugs is nearly as important as reporting them in the
first place. It is valuable to know if a bug can be duplicated on a different
machine, on a different filesystem, on a different architecture, with a
different C library, and so forth.
Note the careful description and use of examples showing not only what BusyBox
does, but also a counter example showing what an equivalent GNU app does. Bug
reports lacking such detail may never be fixed... Thanks for understanding.
To see a listing of all the bugs currently filed against Busybox, look here:
http://bugs.lineo.com/db/pa/lbusybox.html
If you have comments to add to a bug (can / can't duplicate, think a bug
should be closed / reopened), please send it to [bugnumber]@bugs.lineo.com.
The message you send will automatically be forwarded to the mailing list for
all to see.
Write Documentation
@@ -183,16 +177,6 @@ This will show all of the trouble spots or 'questionable' code. Pick a spot,
any spot, these are all invitations for you to contribute.
Consult The Bug-Tracking System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Head to: http://bugs.lineo.com/db/pa/lBusybox.html and look at the bugs on
there. Pick one you think you can fix, and fix it. If it's a wishlist item and
someone's requesting a new feature, take a stab at adding it. Everything
previously said about "reading the mailing list" and "coordinating with the
applet maintainer" still applies.
Add a New Applet
~~~~~~~~~~~~~~~~
@@ -309,16 +293,15 @@ are some guidelines on how to test your changes.
Making Sure Your Patch Doesn't Get Lost
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you don't want your patch to be lost or forgotten, send it to the bug
tracking system (http://bugs.lineo.com). You do this by emailing your patch in
a message to submit@bugs.lineo.com with a subject line something like this:
If you don't want your patch to be lost or forgotten, send it to the busybox
mailing list with a subject line something like this:
[PATCH] - Adds "transmogrify" feature to "foo"
In the body, you should have a pseudo-header that looks like the following:
Package: busybox
Version: v0.50pre (or whatever the current version is)
Version: v1.01pre (or whatever the current version is)
Severity: wishlist
The remainder of the body should read along these lines:
@@ -328,16 +311,6 @@ The remainder of the body should read along these lines:
GNU counterparts and the outputs are identical. I have run the scripts in
the 'tests' directory and nothing breaks.
Detailed instructions on how to submit a bug to the tracking system are at:
http://bugs.lineo.com/Reporting.html
If you have a patch that will fix and close a reported bug, please send a
message to [bugnumber]@bugs.lineo.com with your patch attached. It will catch
people's attention if you have a subject line like the following:
[PATCH INCLUDED] - Fix attached, please apply and close this bug
Improving Your Chances of Patch Acceptance