diff options
| author | Eric Andersen <andersen@codepoet.org> | 2003-07-14 21:21:08 +0000 |
|---|---|---|
| committer | Eric Andersen <andersen@codepoet.org> | 2003-07-14 21:21:08 +0000 |
| commit | cb81e6484d1f50ec2761f6294722407b14add525 (patch) | |
| tree | 81fb6290ef50af3488a5ee0f97150b6503df6a3f /docs/contributing.txt | |
| parent | 74f270a3177a43b29d98b6c5b6a2c5338be8b98f (diff) | |
| download | busybox-w32-cb81e6484d1f50ec2761f6294722407b14add525.tar.gz busybox-w32-cb81e6484d1f50ec2761f6294722407b14add525.tar.bz2 busybox-w32-cb81e6484d1f50ec2761f6294722407b14add525.zip | |
Update a bunch of docs. Run a script to update my email addr.
Diffstat (limited to 'docs/contributing.txt')
| -rw-r--r-- | docs/contributing.txt | 75 |
1 files changed, 24 insertions, 51 deletions
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: | |||
| 113 | Bug Reporting | 113 | Bug Reporting |
| 114 | ~~~~~~~~~~~~~ | 114 | ~~~~~~~~~~~~~ |
| 115 | 115 | ||
| 116 | If you find a bug in Busybox, you can send a bug report to our bug tracking | 116 | If you find bugs, please submit a detailed bug report to the busybox mailing |
| 117 | system (homepage: http://bugs.lineo.com). Instructions on how to send a bug | 117 | list at busybox@busybox.net. A well-written bug report should include a |
| 118 | report to the tracking system can be found at: | 118 | transcript of a shell session that demonstrates the bad behavior and enables |
| 119 | anyone else to duplicate the bug on their own machine. The following is such | ||
| 120 | an example: | ||
| 119 | 121 | ||
| 120 | http://bugs.lineo.com/Reporting.html | 122 | To: busybox@busybox.net |
| 121 | 123 | From: diligent@testing.linux.org | |
| 122 | The README file that comes with Busybox also describes how to submit a bug. | 124 | Subject: /bin/date doesn't work |
| 123 | 125 | ||
| 124 | A well-written bug report should include a transcript of a shell session that | 126 | Package: busybox |
| 125 | demonstrates the bad behavior and enables anyone else to duplicate the bug on | 127 | Version: 1.00 |
| 126 | their 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 | ||
| 139 | Bug Triage | 137 | $ date |
| 140 | ~~~~~~~~~~ | 138 | llegal instruction |
| 141 | 139 | ||
| 142 | Validating 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, |
| 143 | first 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! |
| 144 | machine, on a different filesystem, on a different architecture, with a | ||
| 145 | different C library, and so forth. | ||
| 146 | 142 | ||
| 147 | To 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 | 145 | Note the careful description and use of examples showing not only what BusyBox |
| 146 | does, but also a counter example showing what an equivalent GNU app does. Bug | ||
| 147 | reports lacking such detail may never be fixed... Thanks for understanding. | ||
| 150 | 148 | ||
| 151 | If you have comments to add to a bug (can / can't duplicate, think a bug | ||
| 152 | should be closed / reopened), please send it to [bugnumber]@bugs.lineo.com. | ||
| 153 | The message you send will automatically be forwarded to the mailing list for | ||
| 154 | all to see. | ||
| 155 | 149 | ||
| 156 | 150 | ||
| 157 | Write Documentation | 151 | Write Documentation |
| @@ -183,16 +177,6 @@ This will show all of the trouble spots or 'questionable' code. Pick a spot, | |||
| 183 | any spot, these are all invitations for you to contribute. | 177 | any spot, these are all invitations for you to contribute. |
| 184 | 178 | ||
| 185 | 179 | ||
| 186 | Consult The Bug-Tracking System | ||
| 187 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| 188 | |||
| 189 | Head to: http://bugs.lineo.com/db/pa/lBusybox.html and look at the bugs on | ||
| 190 | there. Pick one you think you can fix, and fix it. If it's a wishlist item and | ||
| 191 | someone's requesting a new feature, take a stab at adding it. Everything | ||
| 192 | previously said about "reading the mailing list" and "coordinating with the | ||
| 193 | applet maintainer" still applies. | ||
| 194 | |||
| 195 | |||
| 196 | Add a New Applet | 180 | Add a New Applet |
| 197 | ~~~~~~~~~~~~~~~~ | 181 | ~~~~~~~~~~~~~~~~ |
| 198 | 182 | ||
| @@ -309,16 +293,15 @@ are some guidelines on how to test your changes. | |||
| 309 | Making Sure Your Patch Doesn't Get Lost | 293 | Making Sure Your Patch Doesn't Get Lost |
| 310 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 294 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 311 | 295 | ||
| 312 | If you don't want your patch to be lost or forgotten, send it to the bug | 296 | If you don't want your patch to be lost or forgotten, send it to the busybox |
| 313 | tracking system (http://bugs.lineo.com). You do this by emailing your patch in | 297 | mailing list with a subject line something like this: |
| 314 | a 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 | ||
| 318 | In the body, you should have a pseudo-header that looks like the following: | 301 | In 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 | ||
| 324 | The remainder of the body should read along these lines: | 307 | The 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 | ||
| 331 | Detailed instructions on how to submit a bug to the tracking system are at: | ||
| 332 | |||
| 333 | http://bugs.lineo.com/Reporting.html | ||
| 334 | |||
| 335 | If you have a patch that will fix and close a reported bug, please send a | ||
| 336 | message to [bugnumber]@bugs.lineo.com with your patch attached. It will catch | ||
| 337 | people'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 | ||
| 343 | Improving Your Chances of Patch Acceptance | 316 | Improving Your Chances of Patch Acceptance |