{"thread":{"id":"18655","subject":"[PATCHv2] Documentation: git-format-patch.txt rewordings and cleanups","startedAt":"2009-03-31T05:14:33Z","lastAt":"2009-03-31T05:14:33Z","messageCount":1,"participants":["Stephen Boyd"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"109963","messageId":"1238476473-22106-1-git-send-email-bebarino@gmail.com","threadId":"18655","inReplyTo":null,"subject":"[PATCHv2] Documentation: git-format-patch.txt rewordings and cleanups","fromName":"Stephen Boyd","fromEmail":"bebarino@gmail.com","sentAt":"2009-03-31T05:14:33Z","receivedAt":"2009-03-31T05:14:33Z","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 and\n--thread descriptions. Add --thread style option to synopsis. Clarify\nrenaming patches example.\n\nSigned-off-by: Stephen Boyd <bebarino@gmail.com>\n---\nThe --suffix words have been updated per the list discussion.\n Documentation/git-format-patch.txt |   33 ++++++++++++++++-----------------\n 1 files changed, 16 insertions(+), 17 deletions(-)\n\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex c2eb5fa..e2b7939 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -9,9 +9,9 @@ git-format-patch - Prepare patches for e-mail submission\n SYNOPSIS\n --------\n [verse]\n-'git format-patch' [-k] [-o <dir> | --stdout] [--thread]\n+'git format-patch' [-k] [-o <dir> | --stdout] [--thread[=<style>]]\n \t\t   [--attach[=<boundary>] | --inline[=<boundary>] |\n-\t\t     [--no-attach]]\n+\t\t    --no-attach]\n \t\t   [-s | --signoff] [<common diff options>]\n \t\t   [-n | --numbered | -N | --no-numbered]\n \t\t   [--start-number <n>] [--numbered-files]\n@@ -132,9 +132,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@@ -169,24 +169,23 @@ 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 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 attachements, and number patches when outputting\n+in the repository configuration, defaults for the subject prefix\n+and file suffix, configure attachments, and number patches when outputting\n more than one.\n \n ------------\n@@ -234,8 +233,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\n"}]}