[PATCH] Doc/Submitting: corrections, additions

+37 -21

2 changed files

expand all

Documentation

+8 -6

Documentation/SubmittingDrivers

··· 13 13 ------------------------- 14 14 15 15 Major and minor numbers for block and character devices are allocated 16 - by the Linux assigned name and number authority (currently better 17 - known as H Peter Anvin). The site is http://www.lanana.org/. This 16 + by the Linux assigned name and number authority (currently this is 17 + Torben Mathiasen). The site is http://www.lanana.org/. This 18 18 also deals with allocating numbers for devices that are not going to 19 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 - get given an assigned number even if that is different from values you may 22 + If you don't use assigned numbers then when your device is submitted it will 23 + be given an assigned number even if that is different from values you may 23 24 have shipped to customers before. 24 25 25 26 Who To Submit Drivers To ··· 33 32 If the code area has a general maintainer then please submit it to 34 33 the maintainer listed in MAINTAINERS in the kernel file. If the 35 34 maintainer does not respond or you cannot find the appropriate 36 - maintainer then please contact Alan Cox <alan@lxorguk.ukuu.org.uk> 35 + maintainer then please contact the 2.2 kernel maintainer: 36 + Marc-Christian Petersen <m.c.p@wolk-project.de>. 37 37 38 38 Linux 2.4: 39 39 The same rules apply as 2.2. The final contact point for Linux 2.4 ··· 50 48 51 49 Licensing: The code must be released to us under the 52 50 GNU General Public License. We don't insist on any kind 53 - of exclusively GPL licensing, and if you wish the driver 51 + of exclusive GPL licensing, and if you wish the driver 54 52 to be useful to other communities such as BSD you may well 55 53 wish to release under multiple licenses. 56 54

+29 -15

Documentation/SubmittingPatches

··· 35 35 36 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 39 MYFILE= drivers/net/mydriver.c 40 40 41 41 cd $SRCTREE ··· 48 48 or unmodified kernel source tree, and generate a diff against your 49 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 54 - mv linux linux-vanilla 55 - wget http://www.moses.uklinux.net/patches/dontdiff 56 - diff -uprN -X dontdiff linux-vanilla $MYSRC > /tmp/patch 57 - rm -f dontdiff 53 + tar xvfz linux-2.6.12.tar.gz 54 + mv linux-2.6.12 linux-2.6.12-vanilla 55 + diff -uprN -X linux-2.6.12-vanilla/Documentation/dontdiff \ 56 + linux-2.6.12-vanilla $MYSRC > /tmp/patch 58 57 59 58 "dontdiff" is a list of files which are generated by the kernel during 60 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 64 Make sure your patch does not include any extra files which do not 64 65 belong in a patch submission. Make sure to review your patch -after- ··· 67 66 68 67 If your changes produce a lot of deltas, you may want to look into 69 68 splitting them into individual patches which modify things in 70 - logical stages, this will facilitate easier reviewing by other 69 + logical stages. This will facilitate easier reviewing by other 71 70 kernel developers, very important if you want your patch accepted. 72 - There are a number of scripts which can aid in this; 71 + There are a number of scripts which can aid in this: 73 72 74 73 Quilt: 75 74 http://savannah.nongnu.org/projects/quilt 76 75 77 76 Randy Dunlap's patch scripts: 78 - http://developer.osdl.org/rddunlap/scripts/patching-scripts.tgz 77 + http://www.xenotime.net/linux/scripts/patching-scripts-002.tar.gz 79 78 80 79 Andrew Morton's patch scripts: 81 - http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.16 80 + http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.20 81 + 82 + 82 83 83 84 2) Describe your changes. 84 85 ··· 166 163 since people copy, as long as it's trivial) 167 164 Any fix by the author/maintainer of the file. (ie. patch monkey 168 165 in re-transmission mode) 166 + URL: <http://www.kernel.org/pub/linux/kernel/people/rusty/trivial/> 167 + 169 168 170 169 171 170 ··· 296 291 point out some special detail about the sign-off. 297 292 298 293 294 + 295 + 12) More references for submitting patches 296 + 297 + Andrew Morton, "The perfect patch" (tpp). 298 + <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt> 299 + 300 + Jeff Garzik, "Linux kernel patch submission format." 301 + <http://linux.yyz.us/patch-format.html> 302 + 303 + 304 + 299 305 ----------------------------------- 300 306 SECTION 2 - HINTS, TIPS, AND TRICKS 301 307 ----------------------------------- ··· 375 359 4) Don't over-design. 376 360 377 361 Don't try to anticipate nebulous future cases which may or may not 378 - be useful: "Make it as simple as you can, and no simpler" 379 - 380 - 362 + be useful: "Make it as simple as you can, and no simpler." 381 363

Configure Feed

Configure Feed