Skip to contentSkip to conversation

Cleanups to Doc*/SubmittingPatches

PATCH In review Pavel Machek 4 participants 5 messages May 14, 2006 – May 15, 2006 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Cleanups to Doc*/SubmittingPatches

This cleans up Submitting patches a bit. Missing/inconsistent full stops, mostly.

Documentation/SubmittingPatches +19 -19
index c2c85bc..07b87ce 100644
@@ -173,17 +173,17 @@ copy the maintainer when you change thei
 For small patches you may want to CC the Trivial Patch Monkey
 [email protected] managed by Adrian Bunk; which collects "trivial"
 patches. Trivial patches must qualify for one of the following rules:
- Spelling fixes in documentation
+ Spelling fixes in documentation.
  Spelling fixes which could break grep(1).
- Warning fixes (cluttering with useless warnings is bad)
- Compilation fixes (only if they are actually correct)
- Runtime fixes (only if they actually fix things)
+ Warning fixes (cluttering with useless warnings is bad).
+ Compilation fixes (only if they are actually correct).
+ Runtime fixes (only if they actually fix things).
  Removing use of deprecated functions/macros (eg. check_region).
- Contact detail and documentation fixes
+ Contact detail and documentation fixes.
  Non-portable code replaced by portable code (even in arch-specific,
- since people copy, as long as it's trivial)
- Any fix by the author/maintainer of the file. (ie. patch monkey
- in re-transmission mode)
+ since people copy, as long as it's trivial).
+ Any fix by the author/maintainer of the file (ie. patch monkey
+ in re-transmission mode).
 URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/>
 
 
@@ -246,13 +246,13 @@ updated change.
 It is quite common for Linus to "drop" your patch without comment.
 That's the nature of the system.  If he drops your patch, it could be
 due to
-* Your patch did not apply cleanly to the latest kernel version
+* Your patch did not apply cleanly to the latest kernel version.
 * Your patch was not sufficiently discussed on linux-kernel.
-* A style issue (see section 2),
-* An e-mail formatting issue (re-read this section)
-* A technical problem with your change
-* He gets tons of e-mail, and yours got lost in the shuffle
-* You are being annoying (See Figure 1)
+* A style issue (see section 2).
+* An e-mail formatting issue (re-read this section).
+* A technical problem with your change.
+* He gets tons of e-mail, and yours got lost in the shuffle.
+* You are being annoying.
 
 When in doubt, solicit comments on linux-kernel mailing list.
 
@@ -475,22 +475,22 @@ 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."
+Jeff Garzik, "Linux kernel patch submission format".
   <http://linux.yyz.us/patch-format.html>
 
-Greg Kroah-Hartman "How to piss off a kernel subsystem maintainer".
+Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
   <http://www.kroah.com/log/2005/03/31/>
   <http://www.kroah.com/log/2005/07/08/>
   <http://www.kroah.com/log/2005/10/19/>
   <http://www.kroah.com/log/2006/01/11/>
 
-NO!!!! No more huge patch bombs to [email protected] people!.
+NO!!!! No more huge patch bombs to [email protected] people!
   <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
 
-Kernel Documentation/CodingStyle
+Kernel Documentation/CodingStyle:
   <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle>
 
-Linus Torvald's mail on the canonical patch format:
+Linus Torvalds's mail on the canonical patch format:
   <http://lkml.org/lkml/2005/4/7/183>
 --
 Last updated on 17 Nov 2005.
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#1 lore raw
Quoted 2 lines · On Sun, 14 May 2006 16:30:38 +0200 Pavel Machek wrote:

This cleans up Submitting patches a bit. Missing/inconsistent full stops, mostly.

Incomplete sentences (fragments) don't need full stops, but they should be consistent.

Documentation/SubmittingPatches copy the maintainer when you change thei · line 177

Quoted 11 lines
Documentation/SubmittingPatches +1 -1
index c2c85bc..07b87ce 100644
@@ -173,17 +173,17 @@ copy the maintainer when you change thei
 For small patches you may want to CC the Trivial Patch Monkey
 [email protected] managed by Adrian Bunk; which collects "trivial"
 patches. Trivial patches must qualify for one of the following rules:
- Spelling fixes in documentation
+ Spelling fixes in documentation.
  Spelling fixes which could break grep(1).

I would just remove that '.' above and skip the rest of the changes in this section.

Quoted 7 lines
Documentation/SubmittingPatches +3 -3
- Warning fixes (cluttering with useless warnings is bad)
- Compilation fixes (only if they are actually correct)
- Runtime fixes (only if they actually fix things)
+ Warning fixes (cluttering with useless warnings is bad).
+ Compilation fixes (only if they are actually correct).
+ Runtime fixes (only if they actually fix things).
  Removing use of deprecated functions/macros (eg. check_region).

Documentation/SubmittingPatches copy the maintainer when you change thei · line 187

Quoted 10 lines
Documentation/SubmittingPatches +4 -4
- Contact detail and documentation fixes
+ Contact detail and documentation fixes.
  Non-portable code replaced by portable code (even in arch-specific,
- since people copy, as long as it's trivial)
- Any fix by the author/maintainer of the file. (ie. patch monkey
- in re-transmission mode)
+ since people copy, as long as it's trivial).
+ Any fix by the author/maintainer of the file (ie. patch monkey
+ in re-transmission mode).
 URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/>

---
~Randy

#2 lore raw

Hi!

Quoted 6 lines
Quoted 2 lines

This cleans up Submitting patches a bit. Missing/inconsistent full stops, mostly.

Incomplete sentences (fragments) don't need full stops, but they should be consistent.

Quoted 14 lines

Documentation/SubmittingPatches copy the maintainer when you change thei · line 177

Quoted 11 lines
Documentation/SubmittingPatches +1 -1
index c2c85bc..07b87ce 100644
@@ -173,17 +173,17 @@ copy the maintainer when you change thei
 For small patches you may want to CC the Trivial Patch Monkey
 [email protected] managed by Adrian Bunk; which collects "trivial"
 patches. Trivial patches must qualify for one of the following rules:
- Spelling fixes in documentation
+ Spelling fixes in documentation.
  Spelling fixes which could break grep(1).

I would just remove that '.' above and skip the rest of the changes in this section.

Does this look better? (Sorry, english is my 2nd language).
Pavel

Documentation/SubmittingPatches +14 -14
index c2c85bc..6f873e5 100644
@@ -174,15 +174,15 @@ For small patches you may want to CC the
 [email protected] managed by Adrian Bunk; which collects "trivial"
 patches. Trivial patches must qualify for one of the following rules:
  Spelling fixes in documentation
- Spelling fixes which could break grep(1).
+ Spelling fixes which could break grep(1)
  Warning fixes (cluttering with useless warnings is bad)
  Compilation fixes (only if they are actually correct)
  Runtime fixes (only if they actually fix things)
- Removing use of deprecated functions/macros (eg. check_region).
+ Removing use of deprecated functions/macros (eg. check_region)
  Contact detail and documentation fixes
  Non-portable code replaced by portable code (even in arch-specific,
  since people copy, as long as it's trivial)
- Any fix by the author/maintainer of the file. (ie. patch monkey
+ Any fix by the author/maintainer of the file (ie. patch monkey
  in re-transmission mode)
 URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/>
 
@@ -246,13 +246,13 @@ updated change.
 It is quite common for Linus to "drop" your patch without comment.
 That's the nature of the system.  If he drops your patch, it could be
 due to
-* Your patch did not apply cleanly to the latest kernel version
+* Your patch did not apply cleanly to the latest kernel version.
 * Your patch was not sufficiently discussed on linux-kernel.
-* A style issue (see section 2),
-* An e-mail formatting issue (re-read this section)
-* A technical problem with your change
-* He gets tons of e-mail, and yours got lost in the shuffle
-* You are being annoying (See Figure 1)
+* A style issue (see section 2).
+* An e-mail formatting issue (re-read this section).
+* A technical problem with your change.
+* He gets tons of e-mail, and yours got lost in the shuffle.
+* You are being annoying.
 
 When in doubt, solicit comments on linux-kernel mailing list.
 
@@ -475,22 +475,22 @@ 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."
+Jeff Garzik, "Linux kernel patch submission format".
   <http://linux.yyz.us/patch-format.html>
 
-Greg Kroah-Hartman "How to piss off a kernel subsystem maintainer".
+Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
   <http://www.kroah.com/log/2005/03/31/>
   <http://www.kroah.com/log/2005/07/08/>
   <http://www.kroah.com/log/2005/10/19/>
   <http://www.kroah.com/log/2006/01/11/>
 
-NO!!!! No more huge patch bombs to [email protected] people!.
+NO!!!! No more huge patch bombs to [email protected] people!
   <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
 
-Kernel Documentation/CodingStyle
+Kernel Documentation/CodingStyle:
   <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle>
 
-Linus Torvald's mail on the canonical patch format:
+Linus Torvalds's mail on the canonical patch format:
   <http://lkml.org/lkml/2005/4/7/183>
 --
 Last updated on 17 Nov 2005.
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#3 lore raw
Quoted 23 lines · On Sun, 14 May 2006 19:23:31 +0200 Pavel Machek wrote:

Hi!

Quoted 6 lines
Quoted 2 lines

This cleans up Submitting patches a bit. Missing/inconsistent full stops, mostly.

Incomplete sentences (fragments) don't need full stops, but they should be consistent.

Quoted 14 lines

Documentation/SubmittingPatches copy the maintainer when you change thei · line 177

Quoted 11 lines
Documentation/SubmittingPatches +1 -1
index c2c85bc..07b87ce 100644
@@ -173,17 +173,17 @@ copy the maintainer when you change thei
 For small patches you may want to CC the Trivial Patch Monkey
 [email protected] managed by Adrian Bunk; which collects "trivial"
 patches. Trivial patches must qualify for one of the following rules:
- Spelling fixes in documentation
+ Spelling fixes in documentation.
  Spelling fixes which could break grep(1).

I would just remove that '.' above and skip the rest of the changes in this section.

Quoted 1 line

Does this look better? (Sorry, english is my 2nd language).

Yes, thanks. You (and the rest of the world) do a better job of communicating in English than many of us could do in another language.

Quoted 60 lines
Documentation/SubmittingPatches +12 -12
index c2c85bc..6f873e5 100644
@@ -174,15 +174,15 @@ For small patches you may want to CC the
 [email protected] managed by Adrian Bunk; which collects "trivial"
 patches. Trivial patches must qualify for one of the following rules:
  Spelling fixes in documentation
- Spelling fixes which could break grep(1).
+ Spelling fixes which could break grep(1)
  Warning fixes (cluttering with useless warnings is bad)
  Compilation fixes (only if they are actually correct)
  Runtime fixes (only if they actually fix things)
- Removing use of deprecated functions/macros (eg. check_region).
+ Removing use of deprecated functions/macros (eg. check_region)
  Contact detail and documentation fixes
  Non-portable code replaced by portable code (even in arch-specific,
  since people copy, as long as it's trivial)
- Any fix by the author/maintainer of the file. (ie. patch monkey
+ Any fix by the author/maintainer of the file (ie. patch monkey
  in re-transmission mode)
 URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/>
 
@@ -246,13 +246,13 @@ updated change.
 It is quite common for Linus to "drop" your patch without comment.
 That's the nature of the system.  If he drops your patch, it could be
 due to
-* Your patch did not apply cleanly to the latest kernel version
+* Your patch did not apply cleanly to the latest kernel version.
 * Your patch was not sufficiently discussed on linux-kernel.
-* A style issue (see section 2),
-* An e-mail formatting issue (re-read this section)
-* A technical problem with your change
-* He gets tons of e-mail, and yours got lost in the shuffle
-* You are being annoying (See Figure 1)
+* A style issue (see section 2).
+* An e-mail formatting issue (re-read this section).
+* A technical problem with your change.
+* He gets tons of e-mail, and yours got lost in the shuffle.
+* You are being annoying.
 
 When in doubt, solicit comments on linux-kernel mailing list.
 
@@ -475,22 +475,22 @@ 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."
+Jeff Garzik, "Linux kernel patch submission format".
   <http://linux.yyz.us/patch-format.html>
 
-Greg Kroah-Hartman "How to piss off a kernel subsystem maintainer".
+Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
   <http://www.kroah.com/log/2005/03/31/>
   <http://www.kroah.com/log/2005/07/08/>
   <http://www.kroah.com/log/2005/10/19/>
   <http://www.kroah.com/log/2006/01/11/>
 
-NO!!!! No more huge patch bombs to [email protected] people!.
+NO!!!! No more huge patch bombs to [email protected] people!

Documentation/SubmittingPatches SECTION 3 - REFERENCES · line 495

Quoted 10 lines
Documentation/SubmittingPatches +2 -2
   <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
 
-Kernel Documentation/CodingStyle
+Kernel Documentation/CodingStyle:
   <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle>
 
-Linus Torvald's mail on the canonical patch format:
+Linus Torvalds's mail on the canonical patch format:
   <http://lkml.org/lkml/2005/4/7/183>
 --

---
~Randy

#4 lore raw
Quoted 6 lines · Randy.Dunlap

On Sun, 14 May 2006 19:23:31 +0200 Pavel Machek wrote:

Yes, thanks. You (and the rest of the world) do a better job of communicating in English than many of us could do in another language.

And sometimes you do better than many of us do in our own native language (which is English ;)

-- Steve