diff --git a/documentation/patches.sgml b/documentation/patches.sgml index d1c3be10c63..42c403eb11d 100644 --- a/documentation/patches.sgml +++ b/documentation/patches.sgml @@ -14,13 +14,13 @@ - A meaningfull subject (very short description of patch) + A meaningful subject (very short description of patch) A long (paragraph) description of what was wrong and what is now - better (and now broken :). (recomended) + better (and now broken :). (recommended) @@ -48,8 +48,8 @@ For additions: mention that you have some new files and - include them as either separate attachments or by appending - the diff -u /dev/null /my/new/file output of them + include them by appending the + diff -u /dev/null /my/new/file output of them to any cvs diff -u output you may have. Alternatively, use diff -Nu olddir/ newdir/ in case of multiple new files to add. @@ -80,8 +80,9 @@ diff -u file.old file.c > file.txt - No HTML mail please. It is considered bad netiquette as it uglifies - the message, and is not viewable by many of the subscribers. + No HTML mail, since patches should be inlined and HTML turns the + patch into garbage. Also it is considered bad netiquette as it + uglifies the message, and is not viewable by many of the subscribers. @@ -94,8 +95,9 @@ diff -u file.old file.c > file.txt - Tabs are not forbidden but are defined as 8 characters and the usual - amount of indentation is 4 characters. + Tabs are not forbidden but discouraged. A tab is defined as + 8 characters and the usual amount of indentation is 4 + characters. @@ -175,6 +177,15 @@ code emails to yourself too. + + Alexandre's Bottom Line + + The basic rules are: no attachments, no mime crap, no + line wrapping, a single patch per mail. Basically if I can't + do "cat raw_mail | patch -p0" it's in the + wrong format. + + @@ -192,7 +203,7 @@ code friend! - Save yourself some embarasment and run your patched code + Save yourself some embarrassment and run your patched code against more than just your current test example. Experience will tell you how much effort to apply here.