{"thread":{"id":"21354","subject":"[PATCH 3/3] format-patch documentation: Fix formatting","startedAt":"2009-10-25T15:56:54Z","lastAt":"2009-10-25T18:47:21Z","messageCount":2,"participants":["Björn Gustavsson"],"isPatch":true,"patchVersion":1,"patchTotal":3},"messages":[{"id":"125897","messageId":"4AE47546.6040804@gmail.com","threadId":"21354","inReplyTo":null,"subject":"[PATCH 3/3] format-patch documentation: Fix formatting","fromName":"Björn Gustavsson","fromEmail":"bgustavsson@gmail.com","sentAt":"2009-10-25T15:56:54Z","receivedAt":"2009-10-25T15:56:54Z","isPatch":true,"sender":{"key":"bgustavsson@gmail.com","avatar":"https://avatars.githubusercontent.com/u/74840?v=4"},"body":"Format git commands and options consistently using back quotes\n(i.e. a fixed font in the resulting HTML document).\n---\n Documentation/diff-options.txt     |   26 ++++++++++----------\n Documentation/git-format-patch.txt |   44 ++++++++++++++++++------------------\n 2 files changed, 35 insertions(+), 35 deletions(-)\n\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex 88e88d7..86d3d80 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -24,7 +24,7 @@ endif::git-format-patch[]\n \tGenerate diffs with <n> lines of context instead of\n \tthe usual three.\n ifndef::git-format-patch[]\n-\tImplies \"-p\".\n+\tImplies `-p`.\n endif::git-format-patch[]\n \n ifndef::git-format-patch[]\n@@ -35,7 +35,7 @@ endif::git-format-patch[]\n \n ifndef::git-format-patch[]\n --patch-with-raw::\n-\tSynonym for \"-p --raw\".\n+\tSynonym for `-p --raw`.\n endif::git-format-patch[]\n \n --patience::\n@@ -67,7 +67,7 @@ endif::git-format-patch[]\n \tcounted for the parent directory, unless \"--cumulative\" is used.\n \n --dirstat-by-file[=limit]::\n-\tSame as --dirstat, but counts changed files instead of lines.\n+\tSame as `--dirstat`, but counts changed files instead of lines.\n \n --summary::\n \tOutput a condensed summary of extended header information\n@@ -75,14 +75,14 @@ endif::git-format-patch[]\n \n ifndef::git-format-patch[]\n --patch-with-stat::\n-\tSynonym for \"-p --stat\".\n+\tSynonym for `-p --stat`.\n endif::git-format-patch[]\n \n ifndef::git-format-patch[]\n -z::\n-\tNUL-line termination on output.  This affects the --raw\n+\tNUL-line termination on output.  This affects the `--raw`\n \toutput field terminator.  Also output from commands such\n-\tas \"git-log\" will be delimited with NUL between commits.\n+\tas `git-log` will be delimited with NUL between commits.\n \n --name-only::\n \tShow only names of changed files.\n@@ -133,16 +133,16 @@ endif::git-format-patch[]\n \tline when generating patch format output.\n \n --binary::\n-\tIn addition to --full-index, output \"binary diff\" that\n-\tcan be applied with \"git apply\".\n+\tIn addition to `--full-index`, output a binary diff that\n+\tcan be applied with `git-apply`.\n \n --abbrev[=<n>]::\n \tInstead of showing the full 40-byte hexadecimal object\n \tname in diff-raw format output and diff-tree header\n \tlines, show only a partial prefix.  This is\n-\tindependent of --full-index option above, which controls\n+\tindependent of the `--full-index` option above, which controls\n \tthe diff-patch output format.  Non default number of\n-\tdigits can be specified with --abbrev=<n>.\n+\tdigits can be specified with `--abbrev=<n>`.\n \n -B::\n \tBreak complete rewrite changes into pairs of delete and create.\n@@ -177,7 +177,7 @@ endif::git-format-patch[]\n \t`-C` option has the same effect.\n \n -l<num>::\n-\t-M and -C options require O(n^2) processing time where n\n+\tThe `-M` and `-C` options require O(n^2) processing time where n\n \tis the number of potential rename/copy targets.  This\n \toption prevents rename/copy detection from running if\n \tthe number of rename/copy targets exceeds the specified\n@@ -191,7 +191,7 @@ ifndef::git-format-patch[]\n \tlinkgit:gitdiffcore[7] for more details.\n \n --pickaxe-all::\n-\tWhen -S finds a change, show all the changes in that\n+\tWhen `-S` finds a change, show all the changes in that\n \tchangeset, not just the files that contain the change\n \tin <string>.\n \n@@ -248,7 +248,7 @@ ifndef::git-format-patch[]\n \t0 means no differences.\n \n --quiet::\n-\tDisable all output of the program. Implies --exit-code.\n+\tDisable all output of the program. Implies `--exit-code`.\n endif::git-format-patch[]\n \n --ext-diff::\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex 687e667..79d77f7 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -43,28 +43,28 @@ There are two ways to specify which commits to operate on.\n \n The first rule takes precedence in the case of a single <commit>.  To\n apply the second rule, i.e., format everything since the beginning of\n-history up until <commit>, use the '\\--root' option: \"git format-patch\n-\\--root <commit>\".  If you want to format only <commit> itself, you\n-can do this with \"git format-patch -1 <commit>\".\n+history up until <commit>, use the '\\--root' option: `git format-patch\n+\\--root <commit>`.  If you want to format only <commit> itself, you\n+can do this with `git format-patch -1 <commit>`.\n \n By default, each output file is numbered sequentially from 1, and uses the\n first line of the commit message (massaged for pathname safety) as\n-the filename. With the --numbered-files option, the output file names\n+the filename. With the `--numbered-files` option, the output file names\n will only be numbers, without the first line of the commit appended.\n The names of the output files are printed to standard\n-output, unless the --stdout option is specified.\n+output, unless the `--stdout` option is specified.\n \n-If -o is specified, output files are created in <dir>.  Otherwise\n+If `-o` is specified, output files are created in <dir>.  Otherwise\n they are created in the current working directory.\n \n By default, the subject of a single patch is \"[PATCH] First Line\" and\n the subject when multiple patches are output is \"[PATCH n/m] First\n-Line\". To force 1/1 to be added for a single patch, use -n.  To omit\n-patch numbers from the subject, use -N\n+Line\". To force 1/1 to be added for a single patch, use `-n`.  To omit\n+patch numbers from the subject, use `-N`.\n \n-If given --thread, 'git-format-patch' will generate In-Reply-To and\n-References headers to make the second and subsequent patch mails appear\n-as replies to the first mail; this also generates a Message-Id header to\n+If given `--thread`, `git-format-patch` will generate `In-Reply-To` and\n+`References` headers to make the second and subsequent patch mails appear\n+as replies to the first mail; this also generates a `Message-Id` header to\n reference.\n \n OPTIONS\n@@ -112,7 +112,7 @@ include::diff-options.txt[]\n --attach[=<boundary>]::\n \tCreate multipart/mixed attachment, the first part of\n \twhich is the commit message and the patch itself in the\n-\tsecond part, with \"Content-Disposition: attachment\".\n+\tsecond part, with `Content-Disposition: attachment`.\n \n --no-attach::\n \tDisable the creation of an attachment, overriding the\n@@ -121,13 +121,13 @@ include::diff-options.txt[]\n --inline[=<boundary>]::\n \tCreate multipart/mixed attachment, the first part of\n \twhich is the commit message and the patch itself in the\n-\tsecond part, with \"Content-Disposition: inline\".\n+\tsecond part, with `Content-Disposition: inline`.\n \n --thread[=<style>]::\n --no-thread::\n-\tControls addition of In-Reply-To and References headers to\n+\tControls addition of `In-Reply-To` and `References` headers to\n \tmake the second and subsequent mails appear as replies to the\n-\tfirst.  Also controls generation of the Message-Id header to\n+\tfirst.  Also controls generation of the `Message-Id` header to\n \treference.\n +\n The optional <style> argument can be either `shallow` or `deep`.\n@@ -136,16 +136,16 @@ 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 threading makes every mail a reply to the previous one.\n +\n-The default is --no-thread, unless the 'format.thread' configuration\n-is set.  If --thread is specified without a style, it defaults to the\n+The default is `--no-thread`, unless the 'format.thread' configuration\n+is set.  If `--thread` is specified without a style, it defaults to the\n style specified by 'format.thread' if any, or else `shallow`.\n +\n Beware that the default for 'git send-email' is to thread emails\n-itself.  If you want 'git format-patch' to take care of hreading, you\n-will want to ensure that threading is disabled for 'git send-email'.\n+itself.  If you want `git format-patch` to take care of threading, you\n+will want to ensure that threading is disabled for `git send-email`.\n \n --in-reply-to=Message-Id::\n-\tMake the first mail (or all the mails with --no-thread) appear as a\n+\tMake the first mail (or all the mails with `--no-thread`) appear as a\n \treply to the given Message-Id, which avoids breaking threads to\n \tprovide a new patch series.\n \n@@ -163,13 +163,13 @@ will want to ensure that threading is disabled for 'git send-email'.\n \tcombined with the --numbered option.\n \n --cc=<email>::\n-\tAdd a \"Cc:\" header to the email headers. This is in addition\n+\tAdd a `Cc:` header to the email headers. This is in addition\n \tto any configured headers, and may be used multiple times.\n \n --add-header=<header>::\n \tAdd an arbitrary header to the email headers.  This is in addition\n \tto any configured headers, and may be used multiple times.\n-\tFor example, --add-header=\"Organization: git-foo\"\n+\tFor example, `--add-header=\"Organization: git-foo\"`\n \n --cover-letter::\n \tIn addition to the patches, generate a cover letter file\n-- \n1.6.5.1.69.g36942\n"},{"id":"125913","messageId":"4AE49D39.7000904@gmail.com","threadId":"21354","inReplyTo":"4AE47546.6040804@gmail.com","subject":"Re: [PATCH 3/3] format-patch documentation: Fix formatting","fromName":"Björn Gustavsson","fromEmail":"bgustavsson@gmail.com","sentAt":"2009-10-25T18:47:21Z","receivedAt":"2009-10-25T18:47:21Z","isPatch":true,"sender":{"key":"bgustavsson@gmail.com","avatar":"https://avatars.githubusercontent.com/u/74840?v=4"},"body":"Björn Gustavsson wrote:\n> Format git commands and options consistently using back quotes\n> (i.e. a fixed font in the resulting HTML document).\n\nI missed a few places. Here is an additional patch to be applied\non top of the original patch.\n\nI'll send out a new combined patch later, but I'll wait for comments\non the series first.\n\n/Björn\n\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex 86d3d80..14265b8 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -43,19 +43,19 @@ endif::git-format-patch[]\n \n --stat[=width[,name-width]]::\n \tGenerate a diffstat.  You can override the default\n-\toutput width for 80-column terminal by \"--stat=width\".\n+\toutput width for 80-column terminal by `--stat=width`.\n \tThe width of the filename part can be controlled by\n \tgiving another width to it separated by a comma.\n \n --numstat::\n-\tSimilar to \\--stat, but shows number of added and\n+\tSimilar to `\\--stat`, but shows number of added and\n \tdeleted lines in decimal notation and pathname without\n \tabbreviation, to make it more machine friendly.  For\n \tbinary files, outputs two `-` instead of saying\n \t`0 0`.\n \n --shortstat::\n-\tOutput only the last line of the --stat format containing total\n+\tOutput only the last line of the `--stat` format containing total\n \tnumber of modified files, as well as number of added and deleted\n \tlines.\n \n@@ -63,8 +63,8 @@ endif::git-format-patch[]\n \tOutput the distribution of relative amount of changes (number of lines added or\n \tremoved) for each sub-directory. Directories with changes below\n \ta cut-off percent (3% by default) are not shown. The cut-off percent\n-\tcan be set with \"--dirstat=limit\". Changes in a child directory is not\n-\tcounted for the parent directory, unless \"--cumulative\" is used.\n+\tcan be set with `--dirstat=limit`. Changes in a child directory is not\n+\tcounted for the parent directory, unless `--cumulative` is used.\n \n --dirstat-by-file[=limit]::\n \tSame as `--dirstat`, but counts changed files instead of lines.\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex 79d77f7..f1fd0df 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -160,7 +160,7 @@ will want to ensure that threading is disabled for `git send-email`.\n \tInstead of the standard '[PATCH]' prefix in the subject\n \tline, instead use '[<Subject-Prefix>]'. This\n \tallows for useful naming of a patch series, and can be\n-\tcombined with the --numbered option.\n+\tcombined with the `--numbered` option.\n \n --cc=<email>::\n \tAdd a `Cc:` header to the email headers. This is in addition\n"}]}