Skip to contentSkip to conversation

docs: updated some code docs

PATCH In review Xose Vazquez Perez 3 participants 6 messages Jul 26, 2005 – Sep 26, 2005 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: updated some code docs

Updated docs about how to write and submit patches/code.

Documentation/CodingStyle +4 -1
diff -Nuar old/Documentation/CodingStyle new/Documentation/CodingStyle
@@ -422,10 +422,13 @@
 URL: http://cm.bell-labs.com/cm/cs/tpop/
 
 GNU manuals - where in compliance with K&R and this text - for cpp, gcc,
-gcc internals and indent, all available from http://www.gnu.org
+gcc internals and indent, all available from http://www.gnu.org/manual/
 
 WG14 is the international standardization working group for the programming
 language C, URL: http://std.dkuug.dk/JTC1/SC22/WG14/
 
+Kernel CodingStyle by [email protected] at OLS 2002:
+http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
+
 --
 Last updated on 16 February 2004 by a community effort on LKML.
Documentation/SubmittingDrivers +16 -7
diff -Nuar old/Documentation/SubmittingDrivers new/Documentation/SubmittingDrivers
@@ -26,17 +26,17 @@
 ------------------------
 
 Linux 2.0:
-	No new drivers are accepted for this kernel tree
+	No new drivers are accepted for this kernel tree.
 
 Linux 2.2:
+	No new drivers are accepted for this kernel tree.
+
+Linux 2.4:
 	If the code area has a general maintainer then please submit it to
 	the maintainer listed in MAINTAINERS in the kernel file. If the
 	maintainer does not respond or you cannot find the appropriate
-	maintainer then please contact Alan Cox <[email protected]>
-
-Linux 2.4:
-	The same rules apply as 2.2. The final contact point for Linux 2.4
-	submissions is Marcelo Tosatti <[email protected]>.
+	maintainer then please contact Marcelo Tosatti
+	<[email protected]>.
 
 Linux 2.6:
 	The same rules apply as 2.4 except that you should follow linux-kernel
@@ -51,6 +51,7 @@
 		of exclusively GPL licensing, and if you wish the driver
 		to be useful to other communities such as BSD you may well
 		wish to release under multiple licenses.
+		See accepted licenses at include/linux/module.h
 
 Copyright:	The copyright owner must agree to use of GPL.
 		It's best if the submitter and copyright owner
@@ -141,5 +142,13 @@
 	http://kernelnewbies.org/
 
 Linux USB project:
-	http://sourceforge.net/projects/linux-usb/
+	http://linux-usb.sourceforge.net/
+
+How to NOT write kernel driver by [email protected]
+	http://people.redhat.com/arjanv/olspaper.pdf
+
+Kernel Janitor:
+	http://janitor.kernelnewbies.org/
 
+--
+Last updated on 25 Jul 2005.
Documentation/SubmittingPatches +39 -7

103 lines not on this page · raw message

#1 lore raw
Quoted 2 lines · Xose Vazquez Perez

Updated docs about how to write and submit patches/code.

Thanks.

I'd like some words in there pointing out that "Andrew Morton's patch scripts" are a pile of crap and people should use quilt. Could you mention that and resend the patch?

#2 lore raw
In reply to Xose Vazquez Perez
Quoted 2 lines · Xose Vazquez Perez

Updated docs about how to write and submit patches/code.

Parts of this should conflict with a patch in -mm from a few weeks ago. then I check and don't see it there.... hrm, wonder what happened to it.

-Separate each logical change into its own patch. +Separate each _logical changes_ into its own patch.
change
or drop "each" and change "its own patch"
to "a single patch file."

On the other hand, if you make a single change to numerous files,
-group those changes into a single patch. Thus a single logical change -is contained within a single patch.
+group those changes into a single patch. Thus single logical changes +are contained within a single patch.

It's better in the original form.

+Do not send more than 15 patches at once to the vger mailing lists!!!

Only in one place, please.

Signature · 1 line
~Randy
#3 lore raw
Quoted 12 lines · Randy Dunlap
(quoted diff) +1 -1
-Separate each logical change into its own patch.
+Separate each _logical changes_ into its own patch.
                        change

or drop "each" and change "its own patch"
to "a single patch file."

On the other hand, if you make a single change to numerous files,

(quoted diff) +2 -2
-group those changes into a single patch.  Thus a single logical change
-is contained within a single patch.
+group those changes into a single patch.  Thus single logical changes
+are contained within a single patch.
Quoted 5 lines

It's better in the original form.

+Do not send more than 15 patches at once to the vger mailing lists!!!

Only in one place, please.

ok, here it goes agains somethig called "Affluent Albatross" aka 2.6.14-rc2-git5

-thanks-

Documentation/CodingStyle +5 -2
diff -Nuar old/Documentation/CodingStyle new/Documentation/CodingStyle
@@ -444,10 +444,13 @@
 URL: http://cm.bell-labs.com/cm/cs/tpop/
 
 GNU manuals - where in compliance with K&R and this text - for cpp, gcc,
-gcc internals and indent, all available from http://www.gnu.org
+gcc internals and indent, all available from http://www.gnu.org/manual/
 
 WG14 is the international standardization working group for the programming
-language C, URL: http://std.dkuug.dk/JTC1/SC22/WG14/
+language C, URL: http://www.open-std.org/JTC1/SC22/WG14/
+
+Kernel CodingStyle by [email protected] at OLS 2002:
+http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
 
 --
 Last updated on 16 February 2004 by a community effort on LKML.
Documentation/SubmittingDrivers +16 -8
diff -Nuar old/Documentation/SubmittingDrivers new/Documentation/SubmittingDrivers
@@ -27,18 +27,17 @@
 ------------------------
 
 Linux 2.0:
-	No new drivers are accepted for this kernel tree
+	No new drivers are accepted for this kernel tree.
 
 Linux 2.2:
+	No new drivers are accepted for this kernel tree.
+
+Linux 2.4:
 	If the code area has a general maintainer then please submit it to
 	the maintainer listed in MAINTAINERS in the kernel file. If the
 	maintainer does not respond or you cannot find the appropriate
-	maintainer then please contact the 2.2 kernel maintainer:
-	Marc-Christian Petersen <[email protected]>.
-
-Linux 2.4:
-	The same rules apply as 2.2. The final contact point for Linux 2.4
-	submissions is Marcelo Tosatti <[email protected]>.
+	maintainer then please contact Marcelo Tosatti
+	<[email protected]>.
 
 Linux 2.6:
 	The same rules apply as 2.4 except that you should follow linux-kernel
@@ -53,6 +52,7 @@
 		of exclusive GPL licensing, and if you wish the driver
 		to be useful to other communities such as BSD you may well
 		wish to release under multiple licenses.
+		See accepted licenses at include/linux/module.h
 
 Copyright:	The copyright owner must agree to use of GPL.
 		It's best if the submitter and copyright owner
@@ -143,5 +143,13 @@
 	http://kernelnewbies.org/
 
 Linux USB project:
-	http://sourceforge.net/projects/linux-usb/
+	http://linux-usb.sourceforge.net/
+
+How to NOT write kernel driver by [email protected]
+	http://people.redhat.com/arjanv/olspaper.pdf
+
+Kernel Janitor:
+	http://janitor.kernelnewbies.org/
 
+--
+Last updated on 25 Sep 2005.
Documentation/SubmittingPatches +35 -12

86 lines not on this page · raw message

#4 lore raw
Quoted 1 line · Xose Vazquez Perez

ok, here it goes agains somethig called "Affluent Albatross" aka 2.6.14-rc2-git5

All looks good to me except for this one line:

Andrew Morton's patch scripts:
-http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.20 +http://www.zip.com.au/~akpm/linux/patches/
+Instead these ones, people should use quilt ASAP (see above).

Make that last line something like:
Instead of these (tools | scripts), quilt is the recommended patch management tool (see above).

Signature · 1 line
~Randy
#5 lore raw
Quoted 9 lines · Randy.Dunlap

All looks good to me except for this one line:

Andrew Morton's patch scripts:

(quoted diff) +1 -1
-http://www.zip.com.au/~akpm/linux/patches/patch-scripts-0.20                   +http://www.zip.com.au/~akpm/linux/patches/
+Instead these ones, people should use quilt ASAP (see above).

Make that last line something like:
Instead of these (tools | scripts), quilt is the recommended patch management tool (see above).

ok. here it goes again.

Documentation/CodingStyle +5 -2
diff -Nuar old/Documentation/CodingStyle new/Documentation/CodingStyle
@@ -444,10 +444,13 @@
 URL: http://cm.bell-labs.com/cm/cs/tpop/
 
 GNU manuals - where in compliance with K&R and this text - for cpp, gcc,
-gcc internals and indent, all available from http://www.gnu.org
+gcc internals and indent, all available from http://www.gnu.org/manual/
 
 WG14 is the international standardization working group for the programming
-language C, URL: http://std.dkuug.dk/JTC1/SC22/WG14/
+language C, URL: http://www.open-std.org/JTC1/SC22/WG14/
+
+Kernel CodingStyle by [email protected] at OLS 2002:
+http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
 
 --
 Last updated on 16 February 2004 by a community effort on LKML.
Documentation/SubmittingDrivers +16 -8
diff -Nuar old/Documentation/SubmittingDrivers new/Documentation/SubmittingDrivers
@@ -27,18 +27,17 @@
 ------------------------
 
 Linux 2.0:
-	No new drivers are accepted for this kernel tree
+	No new drivers are accepted for this kernel tree.
 
 Linux 2.2:
+	No new drivers are accepted for this kernel tree.
+
+Linux 2.4:
 	If the code area has a general maintainer then please submit it to
 	the maintainer listed in MAINTAINERS in the kernel file. If the
 	maintainer does not respond or you cannot find the appropriate
-	maintainer then please contact the 2.2 kernel maintainer:
-	Marc-Christian Petersen <[email protected]>.
-
-Linux 2.4:
-	The same rules apply as 2.2. The final contact point for Linux 2.4
-	submissions is Marcelo Tosatti <[email protected]>.
+	maintainer then please contact Marcelo Tosatti
+	<[email protected]>.
 
 Linux 2.6:
 	The same rules apply as 2.4 except that you should follow linux-kernel
@@ -53,6 +52,7 @@
 		of exclusive GPL licensing, and if you wish the driver
 		to be useful to other communities such as BSD you may well
 		wish to release under multiple licenses.
+		See accepted licenses at include/linux/module.h
 
 Copyright:	The copyright owner must agree to use of GPL.
 		It's best if the submitter and copyright owner
@@ -143,5 +143,13 @@
 	http://kernelnewbies.org/
 
 Linux USB project:
-	http://sourceforge.net/projects/linux-usb/
+	http://linux-usb.sourceforge.net/
+
+How to NOT write kernel driver by [email protected]
+	http://people.redhat.com/arjanv/olspaper.pdf
+
+Kernel Janitor:
+	http://janitor.kernelnewbies.org/
 
+--
+Last updated on 25 Sep 2005.
Documentation/SubmittingPatches +36 -12

87 lines not on this page · raw message