diff options
| -rw-r--r-- | Documentation/SubmittingDrivers | 14 | ||||
| -rw-r--r-- | Documentation/SubmittingPatches | 44 |
2 files changed, 37 insertions, 21 deletions
diff --git a/Documentation/SubmittingDrivers b/Documentation/SubmittingDrivers index de3b252e717d..c3cca924e94b 100644 --- a/Documentation/SubmittingDrivers +++ b/Documentation/SubmittingDrivers | |||
| @@ -13,13 +13,14 @@ Allocating Device Numbers | |||
| 13 | ------------------------- | 13 | ------------------------- |
| 14 | 14 | ||
| 15 | Major and minor numbers for block and character devices are allocated | 15 | Major and minor numbers for block and character devices are allocated |
| 16 | by the Linux assigned name and number authority (currently better | 16 | by the Linux assigned name and number authority (currently this is |
| 17 | known as H Peter Anvin). The site is http://www.lanana.org/. This | 17 | Torben Mathiasen). The site is http://www.lanana.org/. This |
| 18 | also deals with allocating numbers for devices that are not going to | 18 | also deals with allocating numbers for devices that are not going to |
| 19 | be submitted to the mainstream kernel. | 19 | be submitted to the mainstream kernel. |
| 20 | See Documentation/devices.txt for more information on this. | ||
| 20 | 21 | ||
| 21 | If you don't use assigned numbers then when you device is submitted it will | 22 | If you don't use assigned numbers then when your device is submitted it will |
| 22 | get given an assigned number even if that is different from values you may | 23 | be given an assigned number even if that is different from values you may |
| 23 | have shipped to customers before. | 24 | have shipped to customers before. |
| 24 | 25 | ||
| 25 | Who To Submit Drivers To | 26 | Who To Submit Drivers To |
| @@ -32,7 +33,8 @@ Linux 2.2: | |||
| 32 | If the code area has a general maintainer then please submit it to | 33 | If the code area has a general maintainer then please submit it to |
| 33 | the maintainer listed in MAINTAINERS in the kernel file. If the | 34 | the maintainer listed in MAINTAINERS in the kernel file. If the |
| 34 | maintainer does not respond or you cannot find the appropriate | 35 | maintainer does not respond or you cannot find the appropriate |
| 35 | maintainer then please contact Alan Cox <alan@lxorguk.ukuu.org.uk> | 36 | maintainer then please contact the 2.2 kernel maintainer: |
| 37 | Marc-Christian Petersen <m.c.p@wolk-project.de>. | ||
| 36 | 38 | ||
| 37 | Linux 2.4: | 39 | Linux 2.4: |
| 38 | The same rules apply as 2.2. The final contact point for Linux 2.4 | 40 | The same rules apply as 2.2. The final contact point for Linux 2.4 |
| @@ -48,7 +50,7 @@ What Criteria Determine Acceptance | |||
| 48 | 50 | ||
| 49 | Licensing: The code must be released to us under the | 51 | Licensing: The code must be released to us under the |
| 50 | GNU General Public License. We don't insist on any kind | 52 | GNU General Public License. We don't insist on any kind |
| 51 | of exclusively GPL licensing, and if you wish the driver | 53 | of exclusive GPL licensing, and if you wish the driver |
| 52 | to be useful to other communities such as BSD you may well | 54 | to be useful to other communities such as BSD you may well |
| 53 | wish to release under multiple licenses. | 55 | wish to release under multiple licenses. |
| 54 | 56 | ||
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 4d1f41b84ebc..6761a7b241a5 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches | |||
| @@ -35,7 +35,7 @@ not in any lower subdirectory. | |||
| 35 | 35 | ||
| 36 | To create a patch for a single file, it is often sufficient to do: | 36 | To create a patch for a single file, it is often sufficient to do: |
| 37 | 37 | ||
| 38 | SRCTREE= linux-2.4 | 38 | SRCTREE= linux-2.6 |
| 39 | MYFILE= drivers/net/mydriver.c | 39 | MYFILE= drivers/net/mydriver.c |
| 40 | 40 | ||
| 41 | cd $SRCTREE | 41 | cd $SRCTREE |
| @@ -48,17 +48,18 @@ To create a patch for multiple files, you should unpack a "vanilla", | |||
| 48 | or unmodified kernel source tree, and generate a diff against your | 48 | or unmodified kernel source tree, and generate a diff against your |
| 49 | own source tree. For example: | 49 | own source tree. For example: |
| 50 | 50 | ||
| 51 | MYSRC= /devel/linux-2.4 | 51 | MYSRC= /devel/linux-2.6 |
| 52 | 52 | ||
| 53 | tar xvfz linux-2.4.0-test11.tar.gz | 53 | tar xvfz linux-2.6.12.tar.gz |
| 54 | mv linux linux-vanilla | 54 | mv linux-2.6.12 linux-2.6.12-vanilla |
| 55 | wget http://www.moses.uklinux.net/patches/dontdiff | 55 | diff -uprN -X linux-2.6.12-vanilla/Documentation/dontdiff \ |
| 56 | diff -uprN -X dontdiff linux-vanilla $MYSRC > /tmp/patch | 56 | linux-2.6.12-vanilla $MYSRC > /tmp/patch |
| 57 | rm -f dontdiff | ||
| 58 | 57 | ||
| 59 | "dontdiff" is a list of files which are generated by the kernel during | 58 | "dontdiff" is a list of files which are generated by the kernel during |
| 60 | the build process, and should be ignored in any diff(1)-generated | 59 | the build process, and should be ignored in any diff(1)-generated |
| 61 | patch. dontdiff is maintained by Tigran Aivazian <tigran@veritas.com> | 60 | patch. The "dontdiff" file is included in the kernel tree in |
| 61 | 2.6.12 and later. For earlier kernel versions, you can get it | ||
| 62 | from <http://www.xenotime.net/linux/doc/dontdiff>. | ||
| 62 | 63 | ||
| 63 | Make sure your patch does not include any extra files which do not | 64 | Make sure your patch does not include any extra files which do not |
| 64 | belong in a patch submission. Make sure to review your patch -after- | 65 | belong in a patch submission. Make sure to review your patch -after- |
| @@ -66,18 +67,20 @@ generated it with diff(1), to ensure accuracy. | |||
| 66 | 67 | ||
| 67 | If your changes produce a lot of deltas, you may want to look into | 68 | If your changes produce a lot of deltas, you may want to look into |
| 68 | splitting them into individual patches which modify things in | 69 | splitting them into individual patches which modify things in |
| 69 | logical stages, this will facilitate easier reviewing by other | 70 | logical stages. This will facilitate easier reviewing by other |
| 70 | kernel developers, very important if you want your patch accepted. | 71 | kernel developers, very important if you want your patch accepted. |
| 71 | There are a number of scripts which can aid in this; | 72 | There are a number of scripts which can aid in this: |
| 72 | 73 | ||
| 73 | Quilt: | 74 | Quilt: |
| 74 | http://savannah.nongnu.org/projects/quilt | 75 | http://savannah.nongnu.org/projects/quilt |
| 75 | 76 | ||
| 76 | Randy Dunlap's patch scripts: | 77 | Randy Dunlap's patch scripts: |
| 77 | http://developer.osdl.org/rddunlap/scripts/patching-scripts.tgz | 78 | http://www.xenotime.net/linux/scripts/patching-scripts-002.tar.gz |
| 78 | 79 | ||
| 79 | Andrew Morton's patch scripts: | 80 | Andrew Morton's patch scripts: |
| 80 | http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.16 | 81 | http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.20 |
| 82 | |||
| 83 | |||
| 81 | 84 | ||
| 82 | 2) Describe your changes. | 85 | 2) Describe your changes. |
| 83 | 86 | ||
| @@ -163,6 +166,8 @@ patches. Trivial patches must qualify for one of the following rules: | |||
| 163 | since people copy, as long as it's trivial) | 166 | since people copy, as long as it's trivial) |
| 164 | Any fix by the author/maintainer of the file. (ie. patch monkey | 167 | Any fix by the author/maintainer of the file. (ie. patch monkey |
| 165 | in re-transmission mode) | 168 | in re-transmission mode) |
| 169 | URL: <http://www.kernel.org/pub/linux/kernel/people/rusty/trivial/> | ||
| 170 | |||
| 166 | 171 | ||
| 167 | 172 | ||
| 168 | 173 | ||
| @@ -291,6 +296,17 @@ now, but you can do this to mark internal company procedures or just | |||
| 291 | point out some special detail about the sign-off. | 296 | point out some special detail about the sign-off. |
| 292 | 297 | ||
| 293 | 298 | ||
| 299 | |||
| 300 | 12) More references for submitting patches | ||
| 301 | |||
| 302 | Andrew Morton, "The perfect patch" (tpp). | ||
| 303 | <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt> | ||
| 304 | |||
| 305 | Jeff Garzik, "Linux kernel patch submission format." | ||
| 306 | <http://linux.yyz.us/patch-format.html> | ||
| 307 | |||
| 308 | |||
| 309 | |||
| 294 | ----------------------------------- | 310 | ----------------------------------- |
| 295 | SECTION 2 - HINTS, TIPS, AND TRICKS | 311 | SECTION 2 - HINTS, TIPS, AND TRICKS |
| 296 | ----------------------------------- | 312 | ----------------------------------- |
| @@ -359,7 +375,5 @@ and 'extern __inline__'. | |||
| 359 | 4) Don't over-design. | 375 | 4) Don't over-design. |
| 360 | 376 | ||
| 361 | Don't try to anticipate nebulous future cases which may or may not | 377 | Don't try to anticipate nebulous future cases which may or may not |
| 362 | be useful: "Make it as simple as you can, and no simpler" | 378 | be useful: "Make it as simple as you can, and no simpler." |
| 363 | |||
| 364 | |||
| 365 | 379 | ||
