Re: [PATCH 2.6.12 1/1] docs: updated some code docs

[Xose Vazquez Perez <xose.vazquez@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 824 bytes --]

On 7/27/05, Randy Dunlap <rdunlap@xenotime.net> wrote:

> -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.

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

-thanks-

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: code_docs.diff --]
[-- Type: text/x-patch; name="code_docs.diff", Size: 5749 bytes --]

diff -Nuar old/Documentation/CodingStyle new/Documentation/CodingStyle
--- old/Documentation/CodingStyle	2005-09-26 20:02:34.000000000 +0200
+++ new/Documentation/CodingStyle	2005-09-26 20:05:59.000000000 +0200
@@ -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 greg@kroah.com 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.
diff -Nuar old/Documentation/SubmittingDrivers new/Documentation/SubmittingDrivers
--- old/Documentation/SubmittingDrivers	2005-09-26 20:02:34.000000000 +0200
+++ new/Documentation/SubmittingDrivers	2005-09-25 22:05:56.000000000 +0200
@@ -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 <m.c.p@wolk-project.de>.
-
-Linux 2.4:
-	The same rules apply as 2.2. The final contact point for Linux 2.4
-	submissions is Marcelo Tosatti <marcelo.tosatti@cyclades.com>.
+	maintainer then please contact Marcelo Tosatti
+	<marcelo.tosatti@cyclades.com>.
 
 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 arjanv@redhat.com
+	http://people.redhat.com/arjanv/olspaper.pdf
+
+Kernel Janitor:
+	http://janitor.kernelnewbies.org/
 
+--
+Last updated on 25 Sep 2005.
diff -Nuar old/Documentation/SubmittingPatches new/Documentation/SubmittingPatches
--- old/Documentation/SubmittingPatches	2005-09-26 20:02:34.000000000 +0200
+++ new/Documentation/SubmittingPatches	2005-09-26 19:59:49.000000000 +0200
@@ -78,7 +78,8 @@
 http://www.xenotime.net/linux/scripts/patching-scripts-002.tar.gz
 
 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).
 
 
 
@@ -97,7 +98,7 @@
 
 3) Separate your changes.
 
-Separate each logical change into its own patch.
+Separate _logical changes_ into a single patch file.
 
 For example, if your changes include both bug fixes and performance
 enhancements for a single driver, separate those changes into two
@@ -112,6 +113,10 @@
 complete, that is OK.  Simply note "this patch depends on patch X"
 in your patch description.
 
+If you cannot condense your patch set into a smaller set of patches,
+then only post say 15 or so at a time and wait for review and integration.
+
+
 
 4) Select e-mail destination.
 
@@ -124,6 +129,10 @@
 linux-kernel@vger.kernel.org.  Most kernel developers monitor this
 e-mail list, and can comment on your changes.
 
+
+Do not send more than 15 patches at once to the vger mailing lists!!!
+
+
 Linus Torvalds is the final arbiter of all changes accepted into the
 Linux kernel.  His e-mail address is <torvalds@osdl.org>.  He gets
 a lot of e-mail, so typically you should do your best to -avoid- sending
@@ -149,6 +158,9 @@
 MAINTAINERS file for a mailing list that relates specifically to
 your change.
 
+Majordomo lists of VGER.KERNEL.ORG at:
+	http://vger.kernel.org/vger-lists.html
+
 If changes affect userland-kernel interfaces, please send
 the MAN-PAGES maintainer (as listed in the MAINTAINERS file)
 a man-pages patch, or at least a notification of the change,
@@ -302,16 +314,6 @@
 
 
 
-12) More references for submitting patches
-
-Andrew Morton, "The perfect patch" (tpp).
-  <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt>
-
-Jeff Garzik, "Linux kernel patch submission format."
-  <http://linux.yyz.us/patch-format.html>
-
-
-
 -----------------------------------
 SECTION 2 - HINTS, TIPS, AND TRICKS
 -----------------------------------
@@ -382,3 +384,24 @@
 Don't try to anticipate nebulous future cases which may or may not
 be useful:  "Make it as simple as you can, and no simpler."
 
+
+
+----------------------
+SECTION 3 - REFERENCES
+----------------------
+
+Andrew Morton, "The perfect patch" (tpp).
+  <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt>
+
+Jeff Garzik, "Linux kernel patch submission format."
+  <http://linux.yyz.us/patch-format.html>
+
+Greg Kroah, "How to piss off a kernel subsystem maintainer".
+  <http://www.kroah.com/log/2005/03/31/>
+  <http://www.kroah.com/log/2005/07/08/>
+
+NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!.
+  <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
+
+--
+Last updated on 25 Sep 2005.