diff options
Diffstat (limited to 'release/src/router/busybox/docs/contributing.txt')
| -rw-r--r-- | release/src/router/busybox/docs/contributing.txt | 105 |
1 files changed, 39 insertions, 66 deletions
diff --git a/release/src/router/busybox/docs/contributing.txt b/release/src/router/busybox/docs/contributing.txt index 2e004928..aad43035 100644 --- a/release/src/router/busybox/docs/contributing.txt +++ b/release/src/router/busybox/docs/contributing.txt @@ -5,7 +5,7 @@ This document describes what you need to do to contribute to Busybox, where you can help, guidelines on testing, and how to submit a well-formed patch that is more likely to be accepted. -The Busybox home page is at: http://busybox.lineo.com +The Busybox home page is at: http://busybox.net/ @@ -28,8 +28,8 @@ Don't make your work obsolete before you start! For information on how to check out Busybox from CVS, please look at the following links: - http://oss.lineo.com/cvs_anon.html - http://oss.lineo.com/cvs_howto.html + http://busybox.net/cvs_anon.html + http://busybox.net/cvs_howto.html Read the Mailing List @@ -43,7 +43,7 @@ know. Archives can be found here: - http://opensource.lineo.com/lists/busybox/ + http://busybox.net/lists/busybox/ If you have a serious interest in Busybox, i.e., you are using it day-to-day or as part of an embedded project, it would be a good idea to join the mailing @@ -51,7 +51,7 @@ list. A web-based sign-up form can be found here: - http://opensource.lineo.com/mailman/listinfo/busybox + http://busybox.net/mailman/listinfo/busybox Coordinate with the Applet Maintainer @@ -73,7 +73,7 @@ Areas Where You Can Help ------------------------ Busybox can always use improvement! If you're looking for ways to help, there -there are a variety of areas where you could help. +are a variety of areas where you could help. What Busybox Doesn't Need @@ -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: - $ date - codswaddle - + But when I use BusyBox date I get this instead: -Bug Triage -~~~~~~~~~~ + $ date + llegal instruction -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. + 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! -To see a listing of all the bugs currently filed against Busybox, look here: + -Diligent - http://bugs.lineo.com/db/pa/lbusybox.html +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. -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 @@ -177,22 +171,12 @@ Consult Existing Sources For a quick listing of "needs work" spots in the sources, cd into the Busybox directory and run the following: - for i in TODO FIXME XXX; do grep $i *.[ch]; done + for i in TODO FIXME XXX; do find -name '*.[ch]'|xargs grep $i; done 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 ~~~~~~~~~~~~~~~~ @@ -215,22 +199,22 @@ Janitorial Work These are dirty jobs, but somebody's gotta do 'em. - - Converting applets to use getopt() for option processing. Type 'grep -L - getopt *.c' to get a listing of the applets that currently don't use - getopt. If a .c file processes no options, it should have a line that + - Converting applets to use getopt() for option processing. Type 'find -name + '*.c'|grep -L getopt' to get a listing of the applets that currently don't + use getopt. If a .c file processes no options, it should have a line that reads: /* no options, no getopt */ somewhere in the file. - Replace any "naked" calls to malloc, calloc, realloc, str[n]dup, fopen with - the x* equivalents found in utility.c. + the x* equivalents found in libbb/xfuncs.c. - Security audits: - http://www.securityfocus.com/frames/?content=/forums/secprog/secure-programming.html + http://www.securityfocus.com/popups/forums/secprog/intro.shtml - Synthetic code removal: http://www.perl.com/pub/2000/06/commify.html - This is very Perl-specific, but the advice given in here applies equally well to C. - - C library funciton use audits: Verifying that functions are being used + - C library function use audits: Verifying that functions are being used properly (called with the right args), replacing unsafe library functions with safer versions, making sure return codes are being checked, etc. @@ -247,7 +231,7 @@ These are dirty jobs, but somebody's gotta do 'em. - "Ten Commandments" compliance: (this is a "maybe", certainly not as important as any of the previous items.) - http://web.onetelnet.ch/~twolf/tw/c/ten_commandments.html + http://www.lysator.liu.se/c/ten-commandments.html Other useful links: @@ -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 @@ -427,7 +400,7 @@ coder, you may be invited to become a committer, thus enabling you to commit changes directly to CVS. This is nice because you don't have to wait for someone else to commit your change for you, you can just do it yourself. -But note that this is a priviledge that comes with some responsibilities. You +But note that this is a privilege that comes with some responsibilities. You should test your changes before you commit them. You should also talk to an applet maintainer before you make any kind of sweeping changes to somebody else's code. Big changes should still go to the mailing list first. Remember, |