diff options
| author | Xose Vazquez Perez <xose.vazquez@gmail.com> | 2006-01-08 04:02:49 -0500 |
|---|---|---|
| committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-01-08 23:13:53 -0500 |
| commit | 5b0ed2c64d8fdafb5fcfb3baabdd288628b1ff9b (patch) | |
| tree | e73ba55739b27f239cd224a413df9d4b61aff586 | |
| parent | 71fabd5e4835309b4feca6209122ce56c595c461 (diff) | |
[PATCH] docs: updated some code docs
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
| -rw-r--r-- | Documentation/CodingStyle | 7 | ||||
| -rw-r--r-- | Documentation/SubmittingDrivers | 24 | ||||
| -rw-r--r-- | Documentation/SubmittingPatches | 60 |
3 files changed, 63 insertions, 28 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index eb7db3c19227..187e12077e19 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle | |||
| @@ -444,10 +444,13 @@ ISBN 0-201-61586-X. | |||
| 444 | URL: http://cm.bell-labs.com/cm/cs/tpop/ | 444 | URL: http://cm.bell-labs.com/cm/cs/tpop/ |
| 445 | 445 | ||
| 446 | GNU manuals - where in compliance with K&R and this text - for cpp, gcc, | 446 | GNU manuals - where in compliance with K&R and this text - for cpp, gcc, |
| 447 | gcc internals and indent, all available from http://www.gnu.org | 447 | gcc internals and indent, all available from http://www.gnu.org/manual/ |
| 448 | 448 | ||
| 449 | WG14 is the international standardization working group for the programming | 449 | WG14 is the international standardization working group for the programming |
| 450 | language C, URL: http://std.dkuug.dk/JTC1/SC22/WG14/ | 450 | language C, URL: http://www.open-std.org/JTC1/SC22/WG14/ |
| 451 | |||
| 452 | Kernel CodingStyle, by greg@kroah.com at OLS 2002: | ||
| 453 | http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/ | ||
| 451 | 454 | ||
| 452 | -- | 455 | -- |
| 453 | Last updated on 16 February 2004 by a community effort on LKML. | 456 | Last updated on 16 February 2004 by a community effort on LKML. |
diff --git a/Documentation/SubmittingDrivers b/Documentation/SubmittingDrivers index c3cca924e94b..dd311cff1cc3 100644 --- a/Documentation/SubmittingDrivers +++ b/Documentation/SubmittingDrivers | |||
| @@ -27,18 +27,17 @@ Who To Submit Drivers To | |||
| 27 | ------------------------ | 27 | ------------------------ |
| 28 | 28 | ||
| 29 | Linux 2.0: | 29 | Linux 2.0: |
| 30 | No new drivers are accepted for this kernel tree | 30 | No new drivers are accepted for this kernel tree. |
| 31 | 31 | ||
| 32 | Linux 2.2: | 32 | Linux 2.2: |
| 33 | No new drivers are accepted for this kernel tree. | ||
| 34 | |||
| 35 | Linux 2.4: | ||
| 33 | If the code area has a general maintainer then please submit it to | 36 | If the code area has a general maintainer then please submit it to |
| 34 | the maintainer listed in MAINTAINERS in the kernel file. If the | 37 | the maintainer listed in MAINTAINERS in the kernel file. If the |
| 35 | maintainer does not respond or you cannot find the appropriate | 38 | maintainer does not respond or you cannot find the appropriate |
| 36 | maintainer then please contact the 2.2 kernel maintainer: | 39 | maintainer then please contact Marcelo Tosatti |
| 37 | Marc-Christian Petersen <m.c.p@wolk-project.de>. | 40 | <marcelo.tosatti@cyclades.com>. |
| 38 | |||
| 39 | Linux 2.4: | ||
| 40 | The same rules apply as 2.2. The final contact point for Linux 2.4 | ||
| 41 | submissions is Marcelo Tosatti <marcelo.tosatti@cyclades.com>. | ||
| 42 | 41 | ||
| 43 | Linux 2.6: | 42 | Linux 2.6: |
| 44 | The same rules apply as 2.4 except that you should follow linux-kernel | 43 | The same rules apply as 2.4 except that you should follow linux-kernel |
| @@ -53,6 +52,7 @@ Licensing: The code must be released to us under the | |||
| 53 | of exclusive GPL licensing, and if you wish the driver | 52 | of exclusive GPL licensing, and if you wish the driver |
| 54 | to be useful to other communities such as BSD you may well | 53 | to be useful to other communities such as BSD you may well |
| 55 | wish to release under multiple licenses. | 54 | wish to release under multiple licenses. |
| 55 | See accepted licenses at include/linux/module.h | ||
| 56 | 56 | ||
| 57 | Copyright: The copyright owner must agree to use of GPL. | 57 | Copyright: The copyright owner must agree to use of GPL. |
| 58 | It's best if the submitter and copyright owner | 58 | It's best if the submitter and copyright owner |
| @@ -143,5 +143,13 @@ KernelNewbies: | |||
| 143 | http://kernelnewbies.org/ | 143 | http://kernelnewbies.org/ |
| 144 | 144 | ||
| 145 | Linux USB project: | 145 | Linux USB project: |
| 146 | http://sourceforge.net/projects/linux-usb/ | 146 | http://linux-usb.sourceforge.net/ |
| 147 | |||
| 148 | How to NOT write kernel driver by arjanv@redhat.com | ||
| 149 | http://people.redhat.com/arjanv/olspaper.pdf | ||
| 150 | |||
| 151 | Kernel Janitor: | ||
| 152 | http://janitor.kernelnewbies.org/ | ||
| 147 | 153 | ||
| 154 | -- | ||
| 155 | Last updated on 17 Nov 2005. | ||
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 1d47e6c09dc6..3c12fc146940 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches | |||
| @@ -78,7 +78,9 @@ Randy Dunlap's patch scripts: | |||
| 78 | http://www.xenotime.net/linux/scripts/patching-scripts-002.tar.gz | 78 | http://www.xenotime.net/linux/scripts/patching-scripts-002.tar.gz |
| 79 | 79 | ||
| 80 | Andrew Morton's patch scripts: | 80 | Andrew Morton's patch scripts: |
| 81 | http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.20 | 81 | http://www.zip.com.au/~akpm/linux/patches/ |
| 82 | Instead of these scripts, quilt is the recommended patch management | ||
| 83 | tool (see above). | ||
| 82 | 84 | ||
| 83 | 85 | ||
| 84 | 86 | ||
| @@ -97,7 +99,7 @@ need to split up your patch. See #3, next. | |||
| 97 | 99 | ||
| 98 | 3) Separate your changes. | 100 | 3) Separate your changes. |
| 99 | 101 | ||
| 100 | Separate each logical change into its own patch. | 102 | Separate _logical changes_ into a single patch file. |
| 101 | 103 | ||
| 102 | For example, if your changes include both bug fixes and performance | 104 | For example, if your changes include both bug fixes and performance |
| 103 | enhancements for a single driver, separate those changes into two | 105 | enhancements for a single driver, separate those changes into two |
| @@ -112,6 +114,10 @@ If one patch depends on another patch in order for a change to be | |||
| 112 | complete, that is OK. Simply note "this patch depends on patch X" | 114 | complete, that is OK. Simply note "this patch depends on patch X" |
| 113 | in your patch description. | 115 | in your patch description. |
| 114 | 116 | ||
| 117 | If you cannot condense your patch set into a smaller set of patches, | ||
| 118 | then only post say 15 or so at a time and wait for review and integration. | ||
| 119 | |||
| 120 | |||
| 115 | 121 | ||
| 116 | 4) Select e-mail destination. | 122 | 4) Select e-mail destination. |
| 117 | 123 | ||
| @@ -124,6 +130,10 @@ your patch to the primary Linux kernel developer's mailing list, | |||
| 124 | linux-kernel@vger.kernel.org. Most kernel developers monitor this | 130 | linux-kernel@vger.kernel.org. Most kernel developers monitor this |
| 125 | e-mail list, and can comment on your changes. | 131 | e-mail list, and can comment on your changes. |
| 126 | 132 | ||
| 133 | |||
| 134 | Do not send more than 15 patches at once to the vger mailing lists!!! | ||
| 135 | |||
| 136 | |||
| 127 | Linus Torvalds is the final arbiter of all changes accepted into the | 137 | Linus Torvalds is the final arbiter of all changes accepted into the |
| 128 | Linux kernel. His e-mail address is <torvalds@osdl.org>. He gets | 138 | Linux kernel. His e-mail address is <torvalds@osdl.org>. He gets |
| 129 | a lot of e-mail, so typically you should do your best to -avoid- sending | 139 | a lot of e-mail, so typically you should do your best to -avoid- sending |
| @@ -149,6 +159,9 @@ USB, framebuffer devices, the VFS, the SCSI subsystem, etc. See the | |||
| 149 | MAINTAINERS file for a mailing list that relates specifically to | 159 | MAINTAINERS file for a mailing list that relates specifically to |
| 150 | your change. | 160 | your change. |
| 151 | 161 | ||
| 162 | Majordomo lists of VGER.KERNEL.ORG at: | ||
| 163 | <http://vger.kernel.org/vger-lists.html> | ||
| 164 | |||
| 152 | If changes affect userland-kernel interfaces, please send | 165 | If changes affect userland-kernel interfaces, please send |
| 153 | the MAN-PAGES maintainer (as listed in the MAINTAINERS file) | 166 | the MAN-PAGES maintainer (as listed in the MAINTAINERS file) |
| 154 | a man-pages patch, or at least a notification of the change, | 167 | a man-pages patch, or at least a notification of the change, |
| @@ -378,22 +391,6 @@ See more details on the proper patch format in the following | |||
| 378 | references. | 391 | references. |
| 379 | 392 | ||
| 380 | 393 | ||
| 381 | 13) More references for submitting patches | ||
| 382 | |||
| 383 | Andrew Morton, "The perfect patch" (tpp). | ||
| 384 | <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt> | ||
| 385 | |||
| 386 | Jeff Garzik, "Linux kernel patch submission format." | ||
| 387 | <http://linux.yyz.us/patch-format.html> | ||
| 388 | |||
| 389 | Greg KH, "How to piss off a kernel subsystem maintainer" | ||
| 390 | <http://www.kroah.com/log/2005/03/31/> | ||
| 391 | |||
| 392 | Kernel Documentation/CodingStyle | ||
| 393 | <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle> | ||
| 394 | |||
| 395 | Linus Torvald's mail on the canonical patch format: | ||
| 396 | <http://lkml.org/lkml/2005/4/7/183> | ||
| 397 | 394 | ||
| 398 | 395 | ||
| 399 | ----------------------------------- | 396 | ----------------------------------- |
| @@ -466,3 +463,30 @@ and 'extern __inline__'. | |||
| 466 | Don't try to anticipate nebulous future cases which may or may not | 463 | Don't try to anticipate nebulous future cases which may or may not |
| 467 | be useful: "Make it as simple as you can, and no simpler." | 464 | be useful: "Make it as simple as you can, and no simpler." |
| 468 | 465 | ||
| 466 | |||
| 467 | |||
| 468 | ---------------------- | ||
| 469 | SECTION 3 - REFERENCES | ||
| 470 | ---------------------- | ||
| 471 | |||
| 472 | Andrew Morton, "The perfect patch" (tpp). | ||
| 473 | <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt> | ||
| 474 | |||
| 475 | Jeff Garzik, "Linux kernel patch submission format." | ||
| 476 | <http://linux.yyz.us/patch-format.html> | ||
| 477 | |||
| 478 | Greg Kroah, "How to piss off a kernel subsystem maintainer". | ||
