diff options
| author | Kevin Cernekee <cernekee@gmail.com> | 2010-10-10 13:09:31 -0700 |
|---|---|---|
| committer | Denys Vlasenko <vda.linux@googlemail.com> | 2010-10-17 14:12:33 +0200 |
| commit | 20e2c35b7cc77c5dc5696c9592a7d6f982036ac5 (patch) | |
| tree | 32e79d92c62274d213f5a1ca82692aa35bb37a0d /docs | |
| parent | ea694163af05fd9cf71af52d5d8d64af81577b14 (diff) | |
| download | busybox-w32-20e2c35b7cc77c5dc5696c9592a7d6f982036ac5.tar.gz busybox-w32-20e2c35b7cc77c5dc5696c9592a7d6f982036ac5.tar.bz2 busybox-w32-20e2c35b7cc77c5dc5696c9592a7d6f982036ac5.zip | |
docs: Change CVS references to Git
Signed-off-by: Kevin Cernekee <cernekee@gmail.com>
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.txt | 53 |
1 files changed, 32 insertions, 21 deletions
diff --git a/docs/contributing.txt b/docs/contributing.txt index 39aaef1b5..e3289fd49 100644 --- a/docs/contributing.txt +++ b/docs/contributing.txt | |||
| @@ -229,8 +229,11 @@ Here are some guidelines on how to submit a patch to Busybox. | |||
| 229 | Making A Patch | 229 | Making A Patch |
| 230 | ~~~~~~~~~~~~~~ | 230 | ~~~~~~~~~~~~~~ |
| 231 | 231 | ||
| 232 | If you've got anonymous CVS access set up, making a patch is simple. Just make | 232 | If you've got anonymous Git access set up, making a patch is simple. Just make |
| 233 | sure you're in the busybox/ directory and type 'cvs diff -bwu > mychanges.patch'. | 233 | sure you're in the busybox/ directory and type: |
| 234 | |||
| 235 | git diff -b -w > mychanges.patch | ||
| 236 | |||
| 234 | You can send the resulting .patch file to the mailing list with a description | 237 | You can send the resulting .patch file to the mailing list with a description |
| 235 | of what it does. (But not before you test it! See the next section for some | 238 | of what it does. (But not before you test it! See the next section for some |
| 236 | guidelines.) It is preferred that patches be sent as attachments, but it is | 239 | guidelines.) It is preferred that patches be sent as attachments, but it is |
| @@ -238,8 +241,12 @@ not required. | |||
| 238 | 241 | ||
| 239 | Also, feel free to help test other people's patches and reply to them with | 242 | Also, feel free to help test other people's patches and reply to them with |
| 240 | comments. You can apply a patch by saving it into your busybox/ directory and | 243 | comments. You can apply a patch by saving it into your busybox/ directory and |
| 241 | typing 'patch < mychanges.patch'. Then you can recompile, see if it runs, test | 244 | typing: |
| 242 | if it works as advertised, and post your findings to the mailing list. | 245 | |
| 246 | patch -p1 < mychanges.patch | ||
| 247 | |||
| 248 | Then you can recompile, see if it runs, test if it works as advertised, and | ||
| 249 | post your findings to the mailing list. | ||
| 243 | 250 | ||
| 244 | NOTE: Please do not include extraneous or irrelevant changes in your patches. | 251 | NOTE: Please do not include extraneous or irrelevant changes in your patches. |
| 245 | Please do not try to "bundle" two patches together into one. Make single, | 252 | Please do not try to "bundle" two patches together into one. Make single, |
| @@ -252,7 +259,7 @@ Testing Guidelines | |||
| 252 | ~~~~~~~~~~~~~~~~~~ | 259 | ~~~~~~~~~~~~~~~~~~ |
| 253 | 260 | ||
| 254 | It's considered good form to test your new feature before you submit a patch | 261 | It's considered good form to test your new feature before you submit a patch |
| 255 | to the mailing list, and especially before you commit a change to CVS. Here | 262 | to the mailing list, and especially before you push a change to Git. Here |
| 256 | are some guidelines on how to test your changes. | 263 | are some guidelines on how to test your changes. |
| 257 | 264 | ||
| 258 | - Always test Busybox applets against GNU counterparts and make sure the | 265 | - Always test Busybox applets against GNU counterparts and make sure the |
| @@ -348,7 +355,7 @@ responses from queries to applet maintainer or positive responses from folks | |||
| 348 | on the mailing list. | 355 | on the mailing list. |
| 349 | 356 | ||
| 350 | We've made strident efforts to put a useful "collaboration" infrastructure in | 357 | We've made strident efforts to put a useful "collaboration" infrastructure in |
| 351 | place in the form of mailing lists, the bug tracking system, and CVS. Please | 358 | place in the form of mailing lists, the bug tracking system, and Git. Please |
| 352 | use these resources. | 359 | use these resources. |
| 353 | 360 | ||
| 354 | 361 | ||
| @@ -373,39 +380,43 @@ opposite effect. | |||
| 373 | 380 | ||
| 374 | 381 | ||
| 375 | 382 | ||
| 376 | Committing Changes to CVS | 383 | Pushing Changes to Git |
| 377 | ------------------------- | 384 | ---------------------- |
| 378 | 385 | ||
| 379 | If you submit several patches that demonstrate that you are a skilled and wise | 386 | If you submit several patches that demonstrate that you are a skilled and wise |
| 380 | coder, you may be invited to become a committer, thus enabling you to commit | 387 | coder, you may be invited to become a committer, thus enabling you to push |
| 381 | changes directly to CVS. This is nice because you don't have to wait for | 388 | changes directly to Git. This is nice because you don't have to wait for |
| 382 | someone else to commit your change for you, you can just do it yourself. | 389 | someone else to push your change for you, you can just do it yourself. |
| 383 | 390 | ||
| 384 | But note that this is a privilege that comes with some responsibilities. You | 391 | But note that this is a privilege that comes with some responsibilities. You |
| 385 | should test your changes before you commit them. You should also talk to an | 392 | should test your changes before you push them. You should also talk to an |
| 386 | applet maintainer before you make any kind of sweeping changes to somebody | 393 | applet maintainer before you make any kind of sweeping changes to somebody |
| 387 | else's code. Big changes should still go to the mailing list first. Remember, | 394 | else's code. Big changes should still go to the mailing list first. Remember, |
| 388 | being wise, polite, and discreet is more important than being clever. | 395 | being wise, polite, and discreet is more important than being clever. |
| 389 | 396 | ||
| 397 | For more information on Git push access, see: | ||
| 390 | 398 | ||
| 391 | When To Commit | 399 | http://busybox.net/developer.html |
| 392 | ~~~~~~~~~~~~~~ | ||
| 393 | 400 | ||
| 394 | Generally, you should feel free to commit a change if: | 401 | |
| 402 | When To Push | ||
| 403 | ~~~~~~~~~~~~ | ||
| 404 | |||
| 405 | Generally, you should feel free to push a change if: | ||
| 395 | 406 | ||
| 396 | - Your changes are small and don't touch many files | 407 | - Your changes are small and don't touch many files |
| 397 | - You are fixing a bug | 408 | - You are fixing a bug |
| 398 | - Somebody has told you that it's okay | 409 | - Somebody has told you that it's okay |
| 399 | - It's obviously the Right Thing | 410 | - It's obviously the Right Thing |
| 400 | 411 | ||
| 401 | The more of the above are true, the better it is to just commit a change | 412 | The more of the above are true, the better it is to just push a change |
| 402 | directly to CVS. | 413 | directly to Git. |
| 403 | 414 | ||
| 404 | 415 | ||
| 405 | When Not To Commit | 416 | When Not To Push |
| 406 | ~~~~~~~~~~~~~~~~~~ | 417 | ~~~~~~~~~~~~~~~~ |
| 407 | 418 | ||
| 408 | Even if you have commit rights, you should probably still post a patch to the | 419 | Even if you have push access, you should probably still post a patch to the |
| 409 | mailing list if: | 420 | mailing list if: |
| 410 | 421 | ||
| 411 | - Your changes are broad and touch many different files | 422 | - Your changes are broad and touch many different files |
| @@ -414,7 +425,7 @@ mailing list if: | |||
| 414 | - You are not the maintainer and your changes make the maintainer cringe | 425 | - You are not the maintainer and your changes make the maintainer cringe |
| 415 | 426 | ||
| 416 | The more of the above are true, the better it is to post a patch to the | 427 | The more of the above are true, the better it is to post a patch to the |
| 417 | mailing list instead of committing. | 428 | mailing list instead of pushing. |
| 418 | 429 | ||
| 419 | 430 | ||
| 420 | 431 | ||