mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Martin Ågren" <>
Subject: [PATCH 6/6] Doc: use two backticks for monospace, not backtick+apostrophe
Date: Thu, 13 May 2021 20:17:45 +0200	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

In a few places, we wrap the name of an --option or an ENV_VARIABLE in
backtick+apostrophe rather than backtick+backtick. Switch to using
two backticks, as per the coding guidelines.

As an added bonus to rendering these as monospace, we will have them
render the same with AsciiDoc and Asciidoctor. The `quoted' way ends up
as ‘quoted’ vs “quoted”.

Signed-off-by: Martin Ågren <>
 Documentation/config/diff.txt      | 2 +-
 Documentation/git-check-ignore.txt | 2 +-
 Documentation/git-describe.txt     | 2 +-
 Documentation/git-svn.txt          | 6 +++---
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt
index 2d3331f55c..eda0c452d1 100644
--- a/Documentation/config/diff.txt
+++ b/Documentation/config/diff.txt
@@ -69,7 +69,7 @@ diff.interHunkContext::
 	If this config variable is set, diff generation is not
 	performed using the internal diff machinery, but using the
-	given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
+	given command.  Can be overridden with the `GIT_EXTERNAL_DIFF`
 	environment variable.  The command is called with parameters
 	as described under "git Diffs" in linkgit:git[1].  Note: if
 	you want to use an external diff program only on a subset of
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
index 0c3924a63d..ab97ee9d50 100644
--- a/Documentation/git-check-ignore.txt
+++ b/Documentation/git-check-ignore.txt
@@ -21,7 +21,7 @@ input files to the exclude mechanism) and output the path if it is
 By default, tracked files are not shown at all since they are not
-subject to exclude rules; but see `--no-index'.
+subject to exclude rules; but see `--no-index`.
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index a88f6ae2c6..adbbb8907f 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -44,7 +44,7 @@ OPTIONS
 	HEAD".  If the working tree has local modification "-dirty"
 	is appended to it.  If a repository is corrupt and Git
 	cannot determine if there is local modification, Git will
-	error out, unless `--broken' is given, which appends
+	error out, unless `--broken` is given, which appends
 	the suffix "-broken" instead.
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 4e62dc37e7..2491ed47a6 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -361,7 +361,7 @@ where <name> is the name of the SVN repository as specified by the -R option to
 	This should make it easy to look up svn log messages when svn
 	users refer to -r/--revision numbers.
-The following features from `svn log' are supported:
+The following features from `svn log` are supported:
 -r <n>[:<n>];;
@@ -397,7 +397,7 @@ Any other arguments are passed directly to 'git log'
 	Show what revision and author last modified each line of a file. The
 	output of this mode is format-compatible with the output of
-	`svn blame' by default. Like the SVN blame command,
+	`svn blame` by default. Like the SVN blame command,
 	local uncommitted changes in the working tree are ignored;
 	the version of the file in the HEAD revision is annotated. Unknown
 	arguments are passed directly to 'git blame'.
@@ -482,7 +482,7 @@ denotes such an object, or it is requested by invoking an editor (see
 	Shows information about a file or directory similar to what
-	`svn info' provides.  Does not currently support a -r/--revision
+	`svn info` provides.  Does not currently support a -r/--revision
 	argument.  Use the --url option to output only the value of the
 	'URL:' field.

  parent reply	other threads:[~2021-05-13 18:18 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-13 18:17 [PATCH 0/6] AsciiDoc vs Asciidoctor, once again Martin Ågren
2021-05-13 18:17 ` [PATCH 1/6] git-http-push.txt,git-send-pack.txt: avoid single quote Martin Ågren
2021-05-13 18:17 ` [PATCH 2/6] git-range-diff.txt: avoid single quotes Martin Ågren
2021-05-13 18:17 ` [PATCH 3/6] git-check-ref-format.txt: avoid single quote Martin Ågren
2021-05-13 19:16   ` Eric Sunshine
2021-05-13 19:35     ` Martin Ågren
2021-05-13 22:00   ` Junio C Hamano
2021-05-14  9:07     ` Martin Ågren
2021-05-14 12:30       ` Felipe Contreras
2021-05-14  5:30   ` Jeff King
2021-05-14  9:08     ` Martin Ågren
2021-05-13 18:17 ` [PATCH 4/6] diff-options.txt: move monospace markup out of attribute Martin Ågren
2021-05-13 18:17 ` [PATCH 5/6] git-svn.txt: change verse to listing block Martin Ågren
2021-05-13 18:17 ` Martin Ågren [this message]
2021-05-13 20:35 ` [PATCH 0/6] AsciiDoc vs Asciidoctor, once again Junio C Hamano
2021-05-14  8:40   ` Martin Ågren
2021-05-14 12:18     ` Felipe Contreras
2021-05-14  1:40 ` Felipe Contreras
2021-05-14  8:43   ` Martin Ågren
2021-05-14 12:24     ` Felipe Contreras
2021-05-14 15:28       ` Martin Ågren
2021-05-14 20:11         ` Felipe Contreras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).