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>

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index a03f1a793ca2099b749c10f9286d0ebec816e727..9398329706e64d6f0de6d209f88d33738aad7ad4 100644 (file)
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -29,7 +29,7 @@ endif::git-format-patch[]
        Generate diffs with <n> lines of context instead of
        the usual three.
 ifndef::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[]
 endif::git-format-patch[]
 
 ifndef::git-format-patch[]


@@ -40,7 +40,7 @@ endif::git-format-patch[]
 
 ifndef::git-format-patch[]
 --patch-with-raw::
 
 ifndef::git-format-patch[]
 --patch-with-raw::

-       Synonym for "-p --raw".
+       Synonym for `-p --raw`.

 endif::git-format-patch[]
 
 --patience::
 endif::git-format-patch[]
 
 --patience::


@@ -48,19 +48,19 @@ endif::git-format-patch[]
 
 --stat[=width[,name-width]]::
        Generate a diffstat.  You can override the default
 
 --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::
        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::
        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.
 
        number of modified files, as well as number of added and deleted
        lines.
 


@@ -68,11 +68,11 @@ 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
        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]::
 
 --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
 
 --summary::
        Output a condensed summary of extended header information


@@ -80,14 +80,14 @@ endif::git-format-patch[]
 
 ifndef::git-format-patch[]
 --patch-with-stat::
 
 ifndef::git-format-patch[]
 --patch-with-stat::

-       Synonym for "-p --stat".
+       Synonym for `-p --stat`.

 endif::git-format-patch[]
 
 ifndef::git-format-patch[]
 -z::
 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
        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.
 
 --name-only::
        Show only names of changed files.


@@ -139,16 +139,16 @@ endif::git-format-patch[]
        line when generating patch format output.
 
 --binary::
        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
 
 --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
        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.
 
 -B::
        Break complete rewrite changes into pairs of delete and create.


@@ -183,7 +183,7 @@ endif::git-format-patch[]
        `-C` option has the same effect.
 
 -l<num>::
        `-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
        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


@@ -197,7 +197,7 @@ ifndef::git-format-patch[]
        linkgit:gitdiffcore[7] for more details.
 
 --pickaxe-all::
        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>.
 
        changeset, not just the files that contain the change
        in <string>.
 


@@ -254,7 +254,7 @@ ifndef::git-format-patch[]
        0 means no differences.
 
 --quiet::
        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::
 endif::git-format-patch[]
 
 --ext-diff::

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 687e66759817bc2f349e8a5a89aa2c6731237b23..f1fd0df08ae3067f8f5b41797e5575d465a859af 100644 (file)
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -43,28 +43,28 @@ There are two ways to specify which commits to operate on.
 
 The first rule takes precedence in the case of a single <commit>.  To
 apply the second rule, i.e., format everything since the beginning of
 
 The first rule takes precedence in the case of a single <commit>.  To
 apply the second rule, i.e., format everything since the beginning of

-history up until <commit>, use the '\--root' option: "git format-patch
-\--root <commit>".  If you want to format only <commit> itself, you
-can do this with "git format-patch -1 <commit>".
+history up until <commit>, use the '\--root' option: `git format-patch
+\--root <commit>`.  If you want to format only <commit> itself, you
+can do this with `git format-patch -1 <commit>`.

 
 By default, each output file is numbered sequentially from 1, and uses the
 first line of the commit message (massaged for pathname safety) as
 
 By default, each output file is numbered sequentially from 1, and uses the
 first line of the commit message (massaged for pathname safety) as

-the filename. With the --numbered-files option, the output file names
+the filename. With the `--numbered-files` option, the output file names

 will only be numbers, without the first line of the commit appended.
 The names of the output files are printed to standard
 will only be numbers, without the first line of the commit appended.
 The names of the output files are printed to standard

-output, unless the --stdout option is specified.
+output, unless the `--stdout` option is specified.

 
 

-If -o is specified, output files are created in <dir>.  Otherwise
+If `-o` is specified, output files are created in <dir>.  Otherwise

 they are created in the current working directory.
 
 By default, the subject of a single patch is "[PATCH] First Line" and
 the subject when multiple patches are output is "[PATCH n/m] First
 they are created in the current working directory.
 
 By default, the subject of a single patch is "[PATCH] First Line" and
 the subject when multiple patches are output is "[PATCH n/m] First

-Line". To force 1/1 to be added for a single patch, use -n.  To omit
-patch numbers from the subject, use -N
+Line". To force 1/1 to be added for a single patch, use `-n`.  To omit
+patch numbers from the subject, use `-N`.

 
 

-If given --thread, 'git-format-patch' will generate In-Reply-To and
-References headers to make the second and subsequent patch mails appear
-as replies to the first mail; this also generates a Message-Id header to
+If given `--thread`, `git-format-patch` will generate `In-Reply-To` and
+`References` headers to make the second and subsequent patch mails appear
+as replies to the first mail; this also generates a `Message-Id` header to

 reference.
 
 OPTIONS
 reference.
 
 OPTIONS


@@ -112,7 +112,7 @@ include::diff-options.txt[]
 --attach[=<boundary>]::
        Create multipart/mixed attachment, the first part of
        which is the commit message and the patch itself in the
 --attach[=<boundary>]::
        Create multipart/mixed attachment, the first part of
        which is the commit message and the patch itself in the

-       second part, with "Content-Disposition: attachment".
+       second part, with `Content-Disposition: attachment`.

 
 --no-attach::
        Disable the creation of an attachment, overriding the
 
 --no-attach::
        Disable the creation of an attachment, overriding the


@@ -121,13 +121,13 @@ include::diff-options.txt[]
 --inline[=<boundary>]::
        Create multipart/mixed attachment, the first part of
        which is the commit message and the patch itself in the
 --inline[=<boundary>]::
        Create multipart/mixed attachment, the first part of
        which is the commit message and the patch itself in the

-       second part, with "Content-Disposition: inline".
+       second part, with `Content-Disposition: inline`.

 
 --thread[=<style>]::
 --no-thread::
 
 --thread[=<style>]::
 --no-thread::

-       Controls addition of In-Reply-To and References headers to
+       Controls addition of `In-Reply-To` and `References` headers to

        make the second and subsequent mails appear as replies to the
        make the second and subsequent mails appear as replies to the

-       first.  Also controls generation of the Message-Id header to
+       first.  Also controls generation of the `Message-Id` header to

        reference.
 +
 The optional <style> argument can be either `shallow` or `deep`.
        reference.
 +
 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
 `\--in-reply-to`, and the first patch mail, in this order.  'deep'
 threading makes every mail a reply to the previous one.
 +
 `\--in-reply-to`, and the first patch mail, in this order.  'deep'
 threading makes every mail a reply to the previous one.
 +

-The default is --no-thread, unless the 'format.thread' configuration
-is set.  If --thread is specified without a style, it defaults to the
+The default is `--no-thread`, unless the 'format.thread' configuration
+is set.  If `--thread` is specified without a style, it defaults to the

 style specified by 'format.thread' if any, or else `shallow`.
 +
 Beware that the default for 'git send-email' is to thread emails
 style specified by 'format.thread' if any, or else `shallow`.
 +
 Beware that the default for 'git send-email' is to thread emails

-itself.  If you want 'git format-patch' to take care of hreading, you
-will want to ensure that threading is disabled for 'git send-email'.
+itself.  If you want `git format-patch` to take care of threading, you
+will want to ensure that threading is disabled for `git send-email`.

 
 --in-reply-to=Message-Id::
 
 --in-reply-to=Message-Id::

-       Make the first mail (or all the mails with --no-thread) appear as a
+       Make the first mail (or all the mails with `--no-thread`) appear as a

        reply to the given Message-Id, which avoids breaking threads to
        provide a new patch series.
 
        reply to the given Message-Id, which avoids breaking threads to
        provide a new patch series.
 


@@ -160,16 +160,16 @@ 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
        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>::
 
 --cc=<email>::

-       Add a "Cc:" header to the email headers. This is in addition
+       Add a `Cc:` header to the email headers. This is in addition

        to any configured headers, and may be used multiple times.
 
 --add-header=<header>::
        Add an arbitrary header to the email headers.  This is in addition
        to any configured headers, and may be used multiple times.
        to any configured headers, and may be used multiple times.
 
 --add-header=<header>::
        Add an arbitrary header to the email headers.  This is in addition
        to any configured headers, and may be used multiple times.

-       For example, --add-header="Organization: git-foo"
+       For example, `--add-header="Organization: git-foo"`

 
 --cover-letter::
        In addition to the patches, generate a cover letter file
 
 --cover-letter::
        In addition to the patches, generate a cover letter file