format-patch documentation: Fix formatting
PATCH 3/3 format-patch documentation: Fix formatting
Format git commands and options consistently using back quotes (i.e. a fixed font in the resulting HTML document).
--- Documentation/diff-options.txt | 26 ++++++++++---------- Documentation/git-format-patch.txt | 44 ++++++++++++++++++------------------ 2 files changed, 35 insertions(+), 35 deletions(-)
Documentation/diff-options.txt +13 -13
@@ -24,7 +24,7 @@ endif::git-format-patch[] Generate diffs with <n> lines of context instead of the usual three. ifndef::git-format-patch[] - Implies "-p". + Implies `-p`. endif::git-format-patch[] ifndef::git-format-patch[]
@@ -35,7 +35,7 @@ endif::git-format-patch[] ifndef::git-format-patch[] --patch-with-raw:: - Synonym for "-p --raw". + Synonym for `-p --raw`. endif::git-format-patch[] --patience::
@@ -67,7 +67,7 @@ endif::git-format-patch[] counted for the parent directory, unless "--cumulative" is used. --dirstat-by-file[=limit]:: - Same as --dirstat, but counts changed files instead of lines. + Same as `--dirstat`, but counts changed files instead of lines. --summary:: Output a condensed summary of extended header information
@@ -75,14 +75,14 @@ endif::git-format-patch[] ifndef::git-format-patch[] --patch-with-stat:: - Synonym for "-p --stat". + Synonym for `-p --stat`. endif::git-format-patch[] ifndef::git-format-patch[] -z:: - NUL-line termination on output. This affects the --raw + NUL-line termination on output. This affects the `--raw` output field terminator. Also output from commands such - as "git-log" will be delimited with NUL between commits. + as `git-log` will be delimited with NUL between commits. --name-only:: Show only names of changed files.
@@ -133,16 +133,16 @@ endif::git-format-patch[] line when generating patch format output. --binary:: - In addition to --full-index, output "binary diff" that - can be applied with "git apply". + In addition to `--full-index`, output a binary diff that + can be applied with `git-apply`. --abbrev[=<n>]:: Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of --full-index option above, which controls + independent of the `--full-index` option above, which controls the diff-patch output format. Non default number of - digits can be specified with --abbrev=<n>. + digits can be specified with `--abbrev=<n>`. -B:: Break complete rewrite changes into pairs of delete and create.
@@ -177,7 +177,7 @@ endif::git-format-patch[] `-C` option has the same effect. -l<num>:: - -M and -C options require O(n^2) processing time where n + The `-M` and `-C` options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified
@@ -191,7 +191,7 @@ ifndef::git-format-patch[] linkgit:gitdiffcore[7] for more details. --pickaxe-all:: - When -S finds a change, show all the changes in that + When `-S` finds a change, show all the changes in that changeset, not just the files that contain the change in <string>.
@@ -248,7 +248,7 @@ ifndef::git-format-patch[] 0 means no differences. --quiet:: - Disable all output of the program. Implies --exit-code. + Disable all output of the program. Implies `--exit-code`. endif::git-format-patch[] --ext-diff::
Documentation/git-format-patch.txt +22 -22
99 lines not on this page · raw message
Signature · 1 line
1.6.5.1.69.g36942
Quoted 2 lines · Björn Gustavsson
Format git commands and options consistently using back quotes (i.e. a fixed font in the resulting HTML document).
I missed a few places. Here is an additional patch to be applied on top of the original patch.
I'll send out a new combined patch later, but I'll wait for comments on the series first.
/Björn
Documentation/diff-options.txt +5 -5
@@ -43,19 +43,19 @@ endif::git-format-patch[] --stat[=width[,name-width]]:: Generate a diffstat. You can override the default - output width for 80-column terminal by "--stat=width". + output width for 80-column terminal by `--stat=width`. The width of the filename part can be controlled by giving another width to it separated by a comma. --numstat:: - Similar to \--stat, but shows number of added and + Similar to `\--stat`, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For binary files, outputs two `-` instead of saying `0 0`. --shortstat:: - Output only the last line of the --stat format containing total + Output only the last line of the `--stat` format containing total number of modified files, as well as number of added and deleted lines.
@@ -63,8 +63,8 @@ endif::git-format-patch[] Output the distribution of relative amount of changes (number of lines added or removed) for each sub-directory. Directories with changes below a cut-off percent (3% by default) are not shown. The cut-off percent - can be set with "--dirstat=limit". Changes in a child directory is not - counted for the parent directory, unless "--cumulative" is used. + can be set with `--dirstat=limit`. Changes in a child directory is not + counted for the parent directory, unless `--cumulative` is used. --dirstat-by-file[=limit]:: Same as `--dirstat`, but counts changed files instead of lines.
Documentation/git-format-patch.txt +1 -1
@@ -160,7 +160,7 @@ will want to ensure that threading is disabled for `git send-email`. Instead of the standard '[PATCH]' prefix in the subject line, instead use '[<Subject-Prefix>]'. This allows for useful naming of a patch series, and can be - combined with the --numbered option. + combined with the `--numbered` option. --cc=<email>:: Add a `Cc:` header to the email headers. This is in addition