format-patch documentation: Fix formatting
Format git commands and options consistently using back quotes (i.e. a fixed font in the resulting HTML document). Signed-off-by: Björn Gustavsson <bgustavsson@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Björn Gustavsson committed
Nov 7, 2009 at 10:53 UTC
dce5ef142046e107e20aa03ca5a353032bbf9653
2 files changed
+41
-41
Documentation/diff-options.txt
+18
-18
@@ -29,7 +29,7 @@ endif::git-format-patch[]
29
Generate diffs with <n> lines of context instead of
30
the usual three.
31
ifndef::git-format-patch[]
32
- Implies "-p".
32
+ Implies `-p`.
33
endif::git-format-patch[]
34
35
ifndef::git-format-patch[]
@@ -40,7 +40,7 @@ endif::git-format-patch[]
40
41
ifndef::git-format-patch[]
42
--patch-with-raw::
43
- Synonym for "-p --raw".
43
+ Synonym for `-p --raw`.
44
endif::git-format-patch[]
45
46
--patience::
@@ -48,19 +48,19 @@ endif::git-format-patch[]
48
49
--stat[=width[,name-width]]::
50
Generate a diffstat. You can override the default
51
- output width for 80-column terminal by "--stat=width".
51
+ output width for 80-column terminal by `--stat=width`.
52
The width of the filename part can be controlled by
53
giving another width to it separated by a comma.
54
55
--numstat::
56
- Similar to \--stat, but shows number of added and
56
+ Similar to `\--stat`, but shows number of added and
57
deleted lines in decimal notation and pathname without
58
abbreviation, to make it more machine friendly. For
59
binary files, outputs two `-` instead of saying
60
`0 0`.
61
62
--shortstat::
63
- Output only the last line of the --stat format containing total
63
+ Output only the last line of the `--stat` format containing total
64
number of modified files, as well as number of added and deleted
65
lines.
66
@@ -68,11 +68,11 @@ endif::git-format-patch[]
68
Output the distribution of relative amount of changes (number of lines added or
69
removed) for each sub-directory. Directories with changes below
70
a cut-off percent (3% by default) are not shown. The cut-off percent
71
- can be set with "--dirstat=limit". Changes in a child directory is not
72
- counted for the parent directory, unless "--cumulative" is used.
71
+ can be set with `--dirstat=limit`. Changes in a child directory is not
72
+ counted for the parent directory, unless `--cumulative` is used.
73
74
--dirstat-by-file[=limit]::
75
- Same as --dirstat, but counts changed files instead of lines.
75
+ Same as `--dirstat`, but counts changed files instead of lines.
76
77
--summary::
78
Output a condensed summary of extended header information
@@ -80,14 +80,14 @@ endif::git-format-patch[]
80
81
ifndef::git-format-patch[]
82
--patch-with-stat::
83
- Synonym for "-p --stat".
83
+ Synonym for `-p --stat`.
84
endif::git-format-patch[]
85
86
ifndef::git-format-patch[]
87
-z::
88
- NUL-line termination on output. This affects the --raw
88
+ NUL-line termination on output. This affects the `--raw`
89
output field terminator. Also output from commands such
90
- as "git-log" will be delimited with NUL between commits.
90
+ as `git-log` will be delimited with NUL between commits.
91
92
--name-only::
93
Show only names of changed files.
@@ -139,16 +139,16 @@ endif::git-format-patch[]
139
line when generating patch format output.
140
141
--binary::
142
- In addition to --full-index, output "binary diff" that
143
- can be applied with "git apply".
142
+ In addition to `--full-index`, output a binary diff that
143
+ can be applied with `git-apply`.
144
145
--abbrev[=<n>]::
146
Instead of showing the full 40-byte hexadecimal object
147
name in diff-raw format output and diff-tree header
148
lines, show only a partial prefix. This is
149
- independent of --full-index option above, which controls
149
+ independent of the `--full-index` option above, which controls
150
the diff-patch output format. Non default number of
151
- digits can be specified with --abbrev=<n>.
151
+ digits can be specified with `--abbrev=<n>`.
152
153
-B::
154
Break complete rewrite changes into pairs of delete and create.
@@ -183,7 +183,7 @@ endif::git-format-patch[]
183
`-C` option has the same effect.
184
185
-l<num>::
186
- -M and -C options require O(n^2) processing time where n
186
+ The `-M` and `-C` options require O(n^2) processing time where n
187
is the number of potential rename/copy targets. This
188
option prevents rename/copy detection from running if
189
the number of rename/copy targets exceeds the specified
@@ -197,7 +197,7 @@ ifndef::git-format-patch[]
197
linkgit:gitdiffcore[7] for more details.
198
199
--pickaxe-all::
200
- When -S finds a change, show all the changes in that
200
+ When `-S` finds a change, show all the changes in that
201
changeset, not just the files that contain the change
202
in <string>.
203
@@ -254,7 +254,7 @@ ifndef::git-format-patch[]
254
0 means no differences.
255
256
--quiet::
257
- Disable all output of the program. Implies --exit-code.
257
+ Disable all output of the program. Implies `--exit-code`.
258
endif::git-format-patch[]
259
260
--ext-diff::
Documentation/git-format-patch.txt
+23
-23
@@ -43,28 +43,28 @@ There are two ways to specify which commits to operate on.
43
44
The first rule takes precedence in the case of a single <commit>. To
45
apply the second rule, i.e., format everything since the beginning of
46
-history up until <commit>, use the '\--root' option: "git format-patch
47
-\--root <commit>". If you want to format only <commit> itself, you
48
-can do this with "git format-patch -1 <commit>".
46
+history up until <commit>, use the '\--root' option: `git format-patch
47
+\--root <commit>`. If you want to format only <commit> itself, you
48
+can do this with `git format-patch -1 <commit>`.
49
50
By default, each output file is numbered sequentially from 1, and uses the
51
first line of the commit message (massaged for pathname safety) as
52
-the filename. With the --numbered-files option, the output file names
52
+the filename. With the `--numbered-files` option, the output file names
53
will only be numbers, without the first line of the commit appended.
54
The names of the output files are printed to standard
55
-output, unless the --stdout option is specified.
55
+output, unless the `--stdout` option is specified.
56
57
-If -o is specified, output files are created in <dir>. Otherwise
57
+If `-o` is specified, output files are created in <dir>. Otherwise
58
they are created in the current working directory.
59
60
By default, the subject of a single patch is "[PATCH] First Line" and
61
the subject when multiple patches are output is "[PATCH n/m] First
62
-Line". To force 1/1 to be added for a single patch, use -n. To omit
63
-patch numbers from the subject, use -N
62
+Line". To force 1/1 to be added for a single patch, use `-n`. To omit
63
+patch numbers from the subject, use `-N`.
64
65
-If given --thread, 'git-format-patch' will generate In-Reply-To and
66
-References headers to make the second and subsequent patch mails appear
67
-as replies to the first mail; this also generates a Message-Id header to
65
+If given `--thread`, `git-format-patch` will generate `In-Reply-To` and
66
+`References` headers to make the second and subsequent patch mails appear
67
+as replies to the first mail; this also generates a `Message-Id` header to
68
reference.
69
70
OPTIONS
@@ -112,7 +112,7 @@ include::diff-options.txt[]
112
--attach[=<boundary>]::
113
Create multipart/mixed attachment, the first part of
114
which is the commit message and the patch itself in the
115
- second part, with "Content-Disposition: attachment".
115
+ second part, with `Content-Disposition: attachment`.
116
117
--no-attach::
118
Disable the creation of an attachment, overriding the
@@ -121,13 +121,13 @@ include::diff-options.txt[]
121
--inline[=<boundary>]::
122
Create multipart/mixed attachment, the first part of
123
which is the commit message and the patch itself in the
124
- second part, with "Content-Disposition: inline".
124
+ second part, with `Content-Disposition: inline`.
125
126
--thread[=<style>]::
127
--no-thread::
128
- Controls addition of In-Reply-To and References headers to
128
+ Controls addition of `In-Reply-To` and `References` headers to
129
make the second and subsequent mails appear as replies to the
130
- first. Also controls generation of the Message-Id header to
130
+ first. Also controls generation of the `Message-Id` header to
131
reference.
132
+
133
The optional <style> argument can be either `shallow` or `deep`.
@@ -136,16 +136,16 @@ series, where the head is chosen from the cover letter, the
136
`\--in-reply-to`, and the first patch mail, in this order. 'deep'
137
threading makes every mail a reply to the previous one.
138
+
139
-The default is --no-thread, unless the 'format.thread' configuration
140
-is set. If --thread is specified without a style, it defaults to the
139
+The default is `--no-thread`, unless the 'format.thread' configuration
140
+is set. If `--thread` is specified without a style, it defaults to the
141
style specified by 'format.thread' if any, or else `shallow`.
142
+
143
Beware that the default for 'git send-email' is to thread emails
144
-itself. If you want 'git format-patch' to take care of hreading, you
145
-will want to ensure that threading is disabled for 'git send-email'.
144
+itself. If you want `git format-patch` to take care of threading, you
145
+will want to ensure that threading is disabled for `git send-email`.
146
147
--in-reply-to=Message-Id::
148
- Make the first mail (or all the mails with --no-thread) appear as a
148
+ Make the first mail (or all the mails with `--no-thread`) appear as a
149
reply to the given Message-Id, which avoids breaking threads to
150
provide a new patch series.
151
@@ -160,16 +160,16 @@ will want to ensure that threading is disabled for 'git send-email'.
160
Instead of the standard '[PATCH]' prefix in the subject
161
line, instead use '[<Subject-Prefix>]'. This
162
allows for useful naming of a patch series, and can be
163
- combined with the --numbered option.
163
+ combined with the `--numbered` option.
164
165
--cc=<email>::
166
- Add a "Cc:" header to the email headers. This is in addition
166
+ Add a `Cc:` header to the email headers. This is in addition
167
to any configured headers, and may be used multiple times.
168
169
--add-header=<header>::
170
Add an arbitrary header to the email headers. This is in addition
171
to any configured headers, and may be used multiple times.
172
- For example, --add-header="Organization: git-foo"
172
+ For example, `--add-header="Organization: git-foo"`
173
174
--cover-letter::
175
In addition to the patches, generate a cover letter file