{"thread":{"id":"19020","subject":"[PATCH 0/8] Doc updates to config, format-patch, show-branch","startedAt":"2009-04-23T09:37:54Z","lastAt":"2009-04-24T16:18:59Z","messageCount":14,"participants":["Stephen Boyd","Michael J Gruber","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":8},"messages":[{"id":"112063","messageId":"1240479482-31366-1-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":null,"subject":"[PATCH 0/8] Doc updates to config, format-patch, show-branch","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:37:54Z","receivedAt":"2009-04-23T09:37:54Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"I've tried to order these from least to most controversial.\n\nThe first 3 are small fixups. The fourth patch is a quoting fixup. The\nfifth patch is a patch I sent a few weeks ago which flew under the radar.\nThe last 3 patches are some updates to the config.txt documentation.\nI've split them up into seperate patches so they can easily be left out\nif not wanted.\n\nStephen Boyd (8):\n  config.txt: remove pointer to SubmittingPatches\n  config.txt: add missing format.{subjectprefix,cc,attach} variables\n  Documentation: use lowercase for shallow and deep threading\n  git-show-branch.txt: cleanup example description\n  git-format-patch.txt: general rewordings and cleanups\n  config.txt: add missing 'the's and make words plural\n  config.txt: clarify sentences in the configuration and syntax sections\n  config.txt: Make configuration paragraph more consistent\n\n Documentation/config.txt           |   68 +++++++++++++++++++++--------------\n Documentation/git-format-patch.txt |   42 +++++++++++-----------\n Documentation/git-show-branch.txt  |    7 ++--\n 3 files changed, 66 insertions(+), 51 deletions(-)\n"},{"id":"112064","messageId":"1240479482-31366-2-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-1-git-send-email-bebarino@gmail.com","subject":"[PATCH 1/8] config.txt: remove pointer to SubmittingPatches","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:37:55Z","receivedAt":"2009-04-23T09:37:55Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"SubmittingPatches exists in the git source documentation for developers\nof git and is not included in the man/html page distributions.\n\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/config.txt |    1 -\n 1 files changed, 0 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 35056e1..fb7adfa 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -743,7 +743,6 @@ format.signoff::\n     format-patch by default. *Note:* Adding the Signed-off-by: line to a\n     patch should be a conscious act and means that you certify you have\n     the rights to submit this work under the same open source license.\n-    Please see the 'SubmittingPatches' document for further discussion.\n \n gc.aggressiveWindow::\n \tThe window size parameter used in the delta compression\n-- \n1.6.2.3\n"},{"id":"112065","messageId":"1240479482-31366-3-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-2-git-send-email-bebarino@gmail.com","subject":"[PATCH 2/8] config.txt: add missing format.{subjectprefix,cc,attach} variables","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:37:56Z","receivedAt":"2009-04-23T09:37:56Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/config.txt |   15 +++++++++++++++\n 1 files changed, 15 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex fb7adfa..a8b68e2 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -707,6 +707,13 @@ fetch.unpackLimit::\n \tespecially on slow filesystems.  If not set, the value of\n \t`transfer.unpackLimit` is used instead.\n \n+format.attach::\n+\tEnable multipart/mixed attachments as the default for\n+\t'format-patch'.  The value can also be a double quoted string\n+\twhich will enable attachments as the default and set the\n+\tvalue as the boundary.  See the --attach option in\n+\tlinkgit:git-format-patch[1].\n+\n format.numbered::\n \tA boolean which can enable or disable sequence numbers in patch\n \tsubjects.  It defaults to \"auto\" which enables it only if there\n@@ -718,6 +725,14 @@ format.headers::\n \tAdditional email headers to include in a patch to be submitted\n \tby mail.  See linkgit:git-format-patch[1].\n \n+format.cc::\n+\tAdditional \"Cc:\" headers to include in a patch to be submitted\n+\tby mail.  See the --cc option in linkgit:git-format-patch[1].\n+\n+format.subjectprefix::\n+\tThe default for format-patch is to output files with the '[PATCH]'\n+\tsubject prefix. Use this variable to change that prefix.\n+\n format.suffix::\n \tThe default for format-patch is to output files with the suffix\n \t`.patch`. Use this variable to change that suffix (make sure to\n-- \n1.6.2.3\n"},{"id":"112066","messageId":"1240479482-31366-4-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-3-git-send-email-bebarino@gmail.com","subject":"[PATCH 3/8] Documentation: use lowercase for shallow and deep threading","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:37:57Z","receivedAt":"2009-04-23T09:37:57Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"Even when a sentence is started with 'shallow' or 'deep' use the\nlowercase version to maintain consistency.\n\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/config.txt           |    4 ++--\n Documentation/git-format-patch.txt |    4 ++--\n 2 files changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex a8b68e2..cabac97 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -745,11 +745,11 @@ format.pretty::\n \n format.thread::\n \tThe default threading style for 'git-format-patch'.  Can be\n-\teither a boolean value, `shallow` or `deep`.  'Shallow'\n+\teither a boolean value, `shallow` or `deep`.  `shallow`\n \tthreading makes every mail a reply to the head of the series,\n \twhere the head is chosen from the cover letter, the\n \t`\\--in-reply-to`, and the first patch mail, in this order.\n-\t'Deep' threading makes every mail a reply to the previous one.\n+\t`deep` threading makes every mail a reply to the previous one.\n \tA true boolean value is the same as `shallow`, and a false\n \tvalue disables threading.\n \ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex 5eddca9..4a43c64 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -128,9 +128,9 @@ include::diff-options.txt[]\n \tthe Message-Id header to reference.\n +\n The optional <style> argument can be either `shallow` or `deep`.\n-'Shallow' threading makes every mail a reply to the head of the\n+'shallow' threading makes every mail a reply to the head of the\n series, where the head is chosen from the cover letter, the\n-`\\--in-reply-to`, and the first patch mail, in this order.  'Deep'\n+`\\--in-reply-to`, and the first patch mail, in this order.  'deep'\n threading makes every mail a reply to the previous one.  If not\n specified, defaults to the 'format.thread' configuration, or `shallow`\n if that is not set.\n-- \n1.6.2.3\n"},{"id":"112067","messageId":"1240479482-31366-5-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-4-git-send-email-bebarino@gmail.com","subject":"[PATCH 4/8] git-show-branch.txt: cleanup example description","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:37:58Z","receivedAt":"2009-04-23T09:37:58Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"Add a missing quote and properly escape the ' character so docs don't\nlook odd. Add 'the' to make some sentences more gramatically correct.\n\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/git-show-branch.txt |    7 ++++---\n 1 files changed, 4 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt\nindex 7e9ff37..51a4e9d 100644\n--- a/Documentation/git-show-branch.txt\n+++ b/Documentation/git-show-branch.txt\n@@ -148,9 +148,10 @@ $ git show-branch master fixes mhf\n ------------------------------------------------\n \n These three branches all forked from a common commit, [master],\n-whose commit message is \"Add 'git show-branch'.  \"fixes\" branch\n-adds one commit 'Introduce \"reset type\"'.  \"mhf\" branch has many\n-other commits.  The current branch is \"master\".\n+whose commit message is \"Add \\'git show-branch\\'\". The \"fixes\"\n+branch adds one commit \"Introduce \"reset type\" flag to \"git reset\"\".\n+The \"mhf\" branch adds many other commits. The current branch\n+is \"master\".\n \n \n EXAMPLE\n-- \n1.6.2.3\n"},{"id":"112069","messageId":"1240479482-31366-6-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-5-git-send-email-bebarino@gmail.com","subject":"[PATCH 5/8] git-format-patch.txt: general rewordings and cleanups","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:37:59Z","receivedAt":"2009-04-23T09:37:59Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"Clarify --no-binary description using some words from the original\ncommit 37c22a4b (add --no-binary, 2008-05-9). Cleanup --suffix\ndescription. Add --thread style option to synopsis and reorganize it a\nbit. Clarify renaming patches example and the configuration paragraph.\n\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/git-format-patch.txt |   38 ++++++++++++++++++------------------\n 1 files changed, 19 insertions(+), 19 deletions(-)\n\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex 4a43c64..5ac9e33 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -9,10 +9,10 @@ git-format-patch - Prepare patches for e-mail submission\n SYNOPSIS\n --------\n [verse]\n-'git format-patch' [-k] [-o <dir> | --stdout] [--thread]\n-\t\t   [--attach[=<boundary>] | --inline[=<boundary>] |\n-\t\t     [--no-attach]]\n-\t\t   [-s | --signoff] [<common diff options>]\n+'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]\n+\t\t   [--thread[=<style>]]\n+\t\t   [(--attach|--inline)[=<boundary>] | --no-attach]\n+\t\t   [-s | --signoff]\n \t\t   [-n | --numbered | -N | --no-numbered]\n \t\t   [--start-number <n>] [--numbered-files]\n \t\t   [--in-reply-to=Message-Id] [--suffix=.<sfx>]\n@@ -20,6 +20,7 @@ SYNOPSIS\n \t\t   [--subject-prefix=Subject-Prefix]\n \t\t   [--cc=<email>]\n \t\t   [--cover-letter]\n+\t\t   [<common diff options>]\n \t\t   [ <since> | <revision range> ]\n \n DESCRIPTION\n@@ -170,18 +171,17 @@ if that is not set.\n --suffix=.<sfx>::\n \tInstead of using `.patch` as the suffix for generated\n \tfilenames, use specified suffix.  A common alternative is\n-\t`--suffix=.txt`.\n+\t`--suffix=.txt`.  Leaving this empty will remove the `.patch`\n+\tsuffix.\n +\n-Note that you would need to include the leading dot `.` if you\n-want a filename like `0001-description-of-my-change.patch`, and\n-the first letter does not have to be a dot.  Leaving it empty would\n-not add any suffix.\n+Note the leading character does not have to be a dot; for example, you\n+can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.\n \n --no-binary::\n-\tDon't output contents of changes in binary files, just take note\n-\tthat they differ.  Note that this disable the patch to be properly\n-\tapplied.  By default the contents of changes in those files are\n-\tencoded in the patch.\n+\tDo not output contents of changes in binary files, instead\n+\tdisplay a notice that those files changed.  Patches generated\n+\tusing this option cannot be applied properly, but they are\n+\tstill useful for code review.\n \n --root::\n \tTreat the revision argument as a <revision range>, even if it\n@@ -192,10 +192,10 @@ not add any suffix.\n \n CONFIGURATION\n -------------\n-You can specify extra mail header lines to be added to each message\n-in the repository configuration, new defaults for the subject prefix\n-and file suffix, control attachments, and number patches when outputting\n-more than one.\n+You can specify extra mail header lines to be added to each message,\n+defaults for the subject prefix and file suffix, number patches when\n+outputting more than one patch, add \"Cc:\" headers, configure attachments,\n+and signoff patches with configuration variables.\n \n ------------\n [format]\n@@ -243,8 +243,8 @@ $ git format-patch -M -B origin\n +\n Additionally, it detects and handles renames and complete rewrites\n intelligently to produce a renaming patch.  A renaming patch reduces\n-the amount of text output, and generally makes it easier to review it.\n-Note that the \"patch\" program does not understand renaming patches, so\n+the amount of text output, and generally makes it easier to review.\n+Note that non-git \"patch\" programs won't understand renaming patches, so\n use it only when you know the recipient uses git to apply your patch.\n \n * Extract three topmost commits from the current branch and format them\n-- \n1.6.2.3\n"},{"id":"112071","messageId":"1240479482-31366-7-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-6-git-send-email-bebarino@gmail.com","subject":"[PATCH 6/8] config.txt: add missing 'the's and make words plural","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:38:00Z","receivedAt":"2009-04-23T09:38:00Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/config.txt |   34 +++++++++++++++++-----------------\n 1 files changed, 17 insertions(+), 17 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex cabac97..1f17e7a 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -2,10 +2,10 @@ CONFIGURATION FILE\n ------------------\n \n The git configuration file contains a number of variables that affect\n-the git command's behavior. `.git/config` file for each repository\n+the git command's behavior. The `.git/config` file in each repository\n is used to store the information for that repository, and\n-`$HOME/.gitconfig` is used to store per user information to give\n-fallback values for `.git/config` file. The file `/etc/gitconfig`\n+`$HOME/.gitconfig` is used to store per user information as\n+fallback values for the `.git/config` file. The file `/etc/gitconfig`\n can be used to store system-wide defaults.\n \n They can be used by both the git plumbing\n@@ -26,28 +26,28 @@ The file consists of sections and variables.  A section begins with\n the name of the section in square brackets and continues until the next\n section begins.  Section names are not case sensitive.  Only alphanumeric\n characters, `-` and `.` are allowed in section names.  Each variable\n-must belong to some section, which means that there must be section\n-header before first setting of a variable.\n+must belong to some section, which means that there must be a section\n+header before the first setting of a variable.\n \n Sections can be further divided into subsections.  To begin a subsection\n put its name in double quotes, separated by space from the section name,\n-in the section header, like in example below:\n+in the section header, like in the example below:\n \n --------\n \t[section \"subsection\"]\n \n --------\n \n-Subsection names can contain any characters except newline (doublequote\n+Subsection names can contain any character except newline (doublequote\n `\"` and backslash have to be escaped as `\\\"` and `\\\\`,\n-respectively) and are case sensitive.  Section header cannot span multiple\n+respectively) and are case sensitive.  Section headers cannot span multiple\n lines.  Variables may belong directly to a section or to a given subsection.\n You can have `[section]` if you have `[section \"subsection\"]`, but you\n don't need to.\n \n-There is also (case insensitive) alternative `[section.subsection]` syntax.\n-In this syntax subsection names follow the same restrictions as for section\n-name.\n+There is also a case insensitive alternative `[section.subsection]` syntax.\n+In this syntax, subsection names follow the same restrictions as for section\n+names.\n \n All the other lines are recognized as setting variables, in the form\n 'name = value'.  If there is no equal sign on the line, the entire line\n@@ -66,10 +66,10 @@ converting value to the canonical form using '--bool' type specifier;\n 'git-config' will ensure that the output is \"true\" or \"false\".\n \n String values may be entirely or partially enclosed in double quotes.\n-You need to enclose variable value in double quotes if you want to\n-preserve leading or trailing whitespace, or if variable value contains\n-beginning of comment characters (if it contains '#' or ';').\n-Double quote `\"` and backslash `\\` characters in variable value must\n+You need to enclose variable values in double quotes if you want to\n+preserve leading or trailing whitespace, or if the variable value contains\n+comment characters (i.e. it contains '#' or ';').\n+Double quote `\"` and backslash `\\` characters in variable values must\n be escaped: use `\\\"` for `\"` and `\\\\` for `\\`.\n \n The following escape sequences (beside `\\\"` and `\\\\`) are recognized:\n@@ -77,10 +77,10 @@ The following escape sequences (beside `\\\"` and `\\\\`) are recognized:\n and `\\b` for backspace (BS).  No other char escape sequence, nor octal\n char sequences are valid.\n \n-Variable value ending in a `\\` is continued on the next line in the\n+Variable values ending in a `\\` are continued on the next line in the\n customary UNIX fashion.\n \n-Some variables may require special value format.\n+Some variables may require a special value format.\n \n Example\n ~~~~~~~\n-- \n1.6.2.3\n"},{"id":"112068","messageId":"1240479482-31366-8-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-7-git-send-email-bebarino@gmail.com","subject":"[PATCH 7/8] config.txt: clarify sentences in the configuration and syntax sections","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:38:01Z","receivedAt":"2009-04-23T09:38:01Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/config.txt |   12 ++++++------\n 1 files changed, 6 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 1f17e7a..acd9b31 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -8,9 +8,9 @@ is used to store the information for that repository, and\n fallback values for the `.git/config` file. The file `/etc/gitconfig`\n can be used to store system-wide defaults.\n \n-They can be used by both the git plumbing\n-and the porcelains. The variables are divided into sections, where\n-in the fully qualified variable name the variable itself is the last\n+The configuration variables are used by both the git plumbing\n+and the porcelains. The variables are divided into sections, wherein\n+the fully qualified variable name of the variable itself is the last\n dot-separated segment and the section name is everything before the last\n dot. The variable names are case-insensitive and only alphanumeric\n characters are allowed. Some variables may appear multiple times.\n@@ -38,9 +38,9 @@ in the section header, like in the example below:\n \n --------\n \n-Subsection names can contain any character except newline (doublequote\n-`\"` and backslash have to be escaped as `\\\"` and `\\\\`,\n-respectively) and are case sensitive.  Section headers cannot span multiple\n+Subsection names are case sensitive and can contain any characters except\n+newline (doublequote `\"` and backslash have to be escaped as `\\\"` and `\\\\`,\n+respectively).  Section headers cannot span multiple\n lines.  Variables may belong directly to a section or to a given subsection.\n You can have `[section]` if you have `[section \"subsection\"]`, but you\n don't need to.\n-- \n1.6.2.3\n"},{"id":"112070","messageId":"1240479482-31366-9-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"1240479482-31366-8-git-send-email-bebarino@gmail.com","subject":"[PATCH 8/8] config.txt: Make configuration paragraph more consistent","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T09:38:02Z","receivedAt":"2009-04-23T09:38:02Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"By renaming 'information' to 'configuration' we capture more clearly\nwhat a configuration file holds.\n\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n Documentation/config.txt |    6 +++---\n 1 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex acd9b31..0b5dad3 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -3,10 +3,10 @@ CONFIGURATION FILE\n \n The git configuration file contains a number of variables that affect\n the git command's behavior. The `.git/config` file in each repository\n-is used to store the information for that repository, and\n-`$HOME/.gitconfig` is used to store per user information as\n+is used to store the configuration for that repository, and\n+`$HOME/.gitconfig` is used to store a per-user configuration as\n fallback values for the `.git/config` file. The file `/etc/gitconfig`\n-can be used to store system-wide defaults.\n+can be used to store a system-wide default configuration.\n \n The configuration variables are used by both the git plumbing\n and the porcelains. The variables are divided into sections, wherein\n-- \n1.6.2.3\n"},{"id":"112082","messageId":"49F05978.30009@drmicha.warpmail.net","threadId":"19020","inReplyTo":"1240479482-31366-2-git-send-email-bebarino@gmail.com","subject":"Re: [PATCH 1/8] config.txt: remove pointer to SubmittingPatches","fromName":"Michael J Gruber","fromEmail":"git@drmicha.warpmail.net","sentAt":"2009-04-23T12:05:12Z","receivedAt":"2009-04-23T12:05:12Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"Stephen Boyd venit, vidit, dixit 23.04.2009 11:37:\n> SubmittingPatches exists in the git source documentation for developers\n> of git and is not included in the man/html page distributions.\n> \n> Signed-off-by: Stephen Boyd <bebarino@gmail.com>\n> ---\n>  Documentation/config.txt |    1 -\n>  1 files changed, 0 insertions(+), 1 deletions(-)\n> \n> diff --git a/Documentation/config.txt b/Documentation/config.txt\n> index 35056e1..fb7adfa 100644\n> --- a/Documentation/config.txt\n> +++ b/Documentation/config.txt\n> @@ -743,7 +743,6 @@ format.signoff::\n>      format-patch by default. *Note:* Adding the Signed-off-by: line to a\n>      patch should be a conscious act and means that you certify you have\n>      the rights to submit this work under the same open source license.\n> -    Please see the 'SubmittingPatches' document for further discussion.\n\nShouldn't we point to the source then? We're not talking about links\nhere, only references in the sense of referring to further reading.\n\n>  \n>  gc.aggressiveWindow::\n>  \tThe window size parameter used in the delta compression\n"},{"id":"112083","messageId":"49F05B90.8050208@drmicha.warpmail.net","threadId":"19020","inReplyTo":"1240479482-31366-6-git-send-email-bebarino@gmail.com","subject":"Re: [PATCH 5/8] git-format-patch.txt: general rewordings and cleanups","fromName":"Michael J Gruber","fromEmail":"git@drmicha.warpmail.net","sentAt":"2009-04-23T12:14:08Z","receivedAt":"2009-04-23T12:14:08Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"Stephen Boyd venit, vidit, dixit 23.04.2009 11:37:\n> Clarify --no-binary description using some words from the original\n> commit 37c22a4b (add --no-binary, 2008-05-9). Cleanup --suffix\n> description. Add --thread style option to synopsis and reorganize it a\n> bit. Clarify renaming patches example and the configuration paragraph.\n> \n> Signed-off-by: Stephen Boyd <bebarino@gmail.com>\n> ---\n>  Documentation/git-format-patch.txt |   38 ++++++++++++++++++------------------\n>  1 files changed, 19 insertions(+), 19 deletions(-)\n> \n> diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\n> index 4a43c64..5ac9e33 100644\n> --- a/Documentation/git-format-patch.txt\n> +++ b/Documentation/git-format-patch.txt\n> @@ -9,10 +9,10 @@ git-format-patch - Prepare patches for e-mail submission\n>  SYNOPSIS\n>  --------\n>  [verse]\n> -'git format-patch' [-k] [-o <dir> | --stdout] [--thread]\n> -\t\t   [--attach[=<boundary>] | --inline[=<boundary>] |\n> -\t\t     [--no-attach]]\n> -\t\t   [-s | --signoff] [<common diff options>]\n> +'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]\n> +\t\t   [--thread[=<style>]]\n> +\t\t   [(--attach|--inline)[=<boundary>] | --no-attach]\n> +\t\t   [-s | --signoff]\n>  \t\t   [-n | --numbered | -N | --no-numbered]\n>  \t\t   [--start-number <n>] [--numbered-files]\n>  \t\t   [--in-reply-to=Message-Id] [--suffix=.<sfx>]\n> @@ -20,6 +20,7 @@ SYNOPSIS\n>  \t\t   [--subject-prefix=Subject-Prefix]\n>  \t\t   [--cc=<email>]\n>  \t\t   [--cover-letter]\n> +\t\t   [<common diff options>]\n>  \t\t   [ <since> | <revision range> ]\n>  \n>  DESCRIPTION\n> @@ -170,18 +171,17 @@ if that is not set.\n>  --suffix=.<sfx>::\n>  \tInstead of using `.patch` as the suffix for generated\n>  \tfilenames, use specified suffix.  A common alternative is\n> -\t`--suffix=.txt`.\n> +\t`--suffix=.txt`.  Leaving this empty will remove the `.patch`\n> +\tsuffix.\n>  +\n\nThose asciidoc constructs in diff make me always wonder \"Huh? A merge\ndiff -cc?\"... It's fine, of course.\n\n> -Note that you would need to include the leading dot `.` if you\n> -want a filename like `0001-description-of-my-change.patch`, and\n> -the first letter does not have to be a dot.  Leaving it empty would\n> -not add any suffix.\n> +Note the leading character does not have to be a dot; for example, you\n\nMaybe \"Note that the\" sounds and reads better.\n\n> +can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.\n>  \n>  --no-binary::\n> -\tDon't output contents of changes in binary files, just take note\n> -\tthat they differ.  Note that this disable the patch to be properly\n> -\tapplied.  By default the contents of changes in those files are\n> -\tencoded in the patch.\n> +\tDo not output contents of changes in binary files, instead\n> +\tdisplay a notice that those files changed.  Patches generated\n> +\tusing this option cannot be applied properly, but they are\n> +\tstill useful for code review.\n>  \n>  --root::\n>  \tTreat the revision argument as a <revision range>, even if it\n> @@ -192,10 +192,10 @@ not add any suffix.\n>  \n>  CONFIGURATION\n>  -------------\n> -You can specify extra mail header lines to be added to each message\n> -in the repository configuration, new defaults for the subject prefix\n> -and file suffix, control attachments, and number patches when outputting\n> -more than one.\n> +You can specify extra mail header lines to be added to each message,\n> +defaults for the subject prefix and file suffix, number patches when\n> +outputting more than one patch, add \"Cc:\" headers, configure attachments,\n> +and signoff patches with configuration variables.\n\n\"sign off\"\n\n>  \n>  ------------\n>  [format]\n> @@ -243,8 +243,8 @@ $ git format-patch -M -B origin\n>  +\n>  Additionally, it detects and handles renames and complete rewrites\n>  intelligently to produce a renaming patch.  A renaming patch reduces\n> -the amount of text output, and generally makes it easier to review it.\n> -Note that the \"patch\" program does not understand renaming patches, so\n> +the amount of text output, and generally makes it easier to review.\n> +Note that non-git \"patch\" programs won't understand renaming patches, so\n>  use it only when you know the recipient uses git to apply your patch.\n>  \n>  * Extract three topmost commits from the current branch and format them\n\nLooks nice overall, especially the ones I'm not replying to ;)\n\nMichael\n"},{"id":"112092","messageId":"49F0915D.9030009@gmail.com","threadId":"19020","inReplyTo":"49F05978.30009@drmicha.warpmail.net","subject":"Re: [PATCH 1/8] config.txt: remove pointer to SubmittingPatches","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T16:03:41Z","receivedAt":"2009-04-23T16:03:41Z","isPatch":true,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"Michael J Gruber wrote:\n> Stephen Boyd venit, vidit, dixit 23.04.2009 11:37:\n>> SubmittingPatches exists in the git source documentation for developers\n>> of git and is not included in the man/html page distributions.\n>>\n>> Signed-off-by: Stephen Boyd <bebarino@gmail.com>\n>> ---\n>>  Documentation/config.txt |    1 -\n>>  1 files changed, 0 insertions(+), 1 deletions(-)\n>>\n>> diff --git a/Documentation/config.txt b/Documentation/config.txt\n>> index 35056e1..fb7adfa 100644\n>> --- a/Documentation/config.txt\n>> +++ b/Documentation/config.txt\n>> @@ -743,7 +743,6 @@ format.signoff::\n>>      format-patch by default. *Note:* Adding the Signed-off-by: line to a\n>>      patch should be a conscious act and means that you certify you have\n>>      the rights to submit this work under the same open source license.\n>> -    Please see the 'SubmittingPatches' document for further discussion.\n>\n> Shouldn't we point to the source then? We're not talking about links\n> here, only references in the sense of referring to further reading.\n\nI was thinking that a user isn't going to download the source for git so\nthey can read the SubmittingPatches document. Although, it's possible\nthey downloaded the tarball and built from source so they would have the\nfile.\n\nNow I'm starting to dislike this whole paragraph because git isn't used\nexclusively for open source software. Seems like others agree with a\nlittle searching of gmane[1]\nI think Andreas Ericsson's version with Jeff King's updates would be good.\n\nJunio, I would say drop this patch.\n\n\n[1] http://thread.gmane.org/gmane.comp.version-control.git/115299\n"},{"id":"112093","messageId":"1240503412-6790-1-git-send-email-bebarino@gmail.com","threadId":"19020","inReplyTo":"49F05B90.8050208@drmicha.warpmail.net","subject":"[PATCHv2 5/8] git-format-patch.txt: general rewordings and cleanups","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-04-23T16:16:52Z","receivedAt":"2009-04-23T16:16:52Z","isPatch":false,"sender":{"key":"bebarino@gmail.com","avatar":"https://avatars.githubusercontent.com/u/38832?v=4"},"body":"Clarify --no-binary description using some words from the original\ncommit 37c22a4b (add --no-binary, 2008-05-9). Cleanup --suffix\ndescription. Add --thread style option to synopsis and reorganize it a\nbit. Clarify renaming patches example and the configuration paragraph.\n\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\n\n    Fix some issues brought up by Michael J Gruber\n\n Documentation/git-format-patch.txt |   38 ++++++++++++++++++------------------\n 1 files changed, 19 insertions(+), 19 deletions(-)\n\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex 4a43c64..6f1fc80 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -9,10 +9,10 @@ git-format-patch - Prepare patches for e-mail submission\n SYNOPSIS\n --------\n [verse]\n-'git format-patch' [-k] [-o <dir> | --stdout] [--thread]\n-\t\t   [--attach[=<boundary>] | --inline[=<boundary>] |\n-\t\t     [--no-attach]]\n-\t\t   [-s | --signoff] [<common diff options>]\n+'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]\n+\t\t   [--thread[=<style>]]\n+\t\t   [(--attach|--inline)[=<boundary>] | --no-attach]\n+\t\t   [-s | --signoff]\n \t\t   [-n | --numbered | -N | --no-numbered]\n \t\t   [--start-number <n>] [--numbered-files]\n \t\t   [--in-reply-to=Message-Id] [--suffix=.<sfx>]\n@@ -20,6 +20,7 @@ SYNOPSIS\n \t\t   [--subject-prefix=Subject-Prefix]\n \t\t   [--cc=<email>]\n \t\t   [--cover-letter]\n+\t\t   [<common diff options>]\n \t\t   [ <since> | <revision range> ]\n \n DESCRIPTION\n@@ -170,18 +171,17 @@ if that is not set.\n --suffix=.<sfx>::\n \tInstead of using `.patch` as the suffix for generated\n \tfilenames, use specified suffix.  A common alternative is\n-\t`--suffix=.txt`.\n+\t`--suffix=.txt`.  Leaving this empty will remove the `.patch`\n+\tsuffix.\n +\n-Note that you would need to include the leading dot `.` if you\n-want a filename like `0001-description-of-my-change.patch`, and\n-the first letter does not have to be a dot.  Leaving it empty would\n-not add any suffix.\n+Note that the leading character does not have to be a dot; for example,\n+you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.\n \n --no-binary::\n-\tDon't output contents of changes in binary files, just take note\n-\tthat they differ.  Note that this disable the patch to be properly\n-\tapplied.  By default the contents of changes in those files are\n-\tencoded in the patch.\n+\tDo not output contents of changes in binary files, instead\n+\tdisplay a notice that those files changed.  Patches generated\n+\tusing this option cannot be applied properly, but they are\n+\tstill useful for code review.\n \n --root::\n \tTreat the revision argument as a <revision range>, even if it\n@@ -192,10 +192,10 @@ not add any suffix.\n \n CONFIGURATION\n -------------\n-You can specify extra mail header lines to be added to each message\n-in the repository configuration, new defaults for the subject prefix\n-and file suffix, control attachments, and number patches when outputting\n-more than one.\n+You can specify extra mail header lines to be added to each message,\n+defaults for the subject prefix and file suffix, number patches when\n+outputting more than one patch, add \"Cc:\" headers, configure attachments,\n+and sign off patches with configuration variables.\n \n ------------\n [format]\n@@ -243,8 +243,8 @@ $ git format-patch -M -B origin\n +\n Additionally, it detects and handles renames and complete rewrites\n intelligently to produce a renaming patch.  A renaming patch reduces\n-the amount of text output, and generally makes it easier to review it.\n-Note that the \"patch\" program does not understand renaming patches, so\n+the amount of text output, and generally makes it easier to review.\n+Note that non-git \"patch\" programs won't understand renaming patches, so\n use it only when you know the recipient uses git to apply your patch.\n \n * Extract three topmost commits from the current branch and format them\n-- \n1.6.2.3\n"},{"id":"112209","messageId":"7v7i1af2j0.fsf@gitster.siamese.dyndns.org","threadId":"19020","inReplyTo":"1240503412-6790-1-git-send-email-bebarino@gmail.com","subject":"Re: [PATCHv2 5/8] git-format-patch.txt: general rewordings and cleanups","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2009-04-24T16:18:59Z","receivedAt":"2009-04-24T16:18:59Z","isPatch":false,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Thanks, both.\n"}]}