diff mbox series

[6/6] Doc: use two backticks for monospace, not backtick+apostrophe

Message ID f0af6c8f6aeb765a2670cc6c097059c591cdcedc.1620928059.git.martin.agren@gmail.com (mailing list archive)
State New
Headers show
Series AsciiDoc vs Asciidoctor, once again | expand

Commit Message

Martin Ågren May 13, 2021, 6:17 p.m. UTC
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 <martin.agren@gmail.com>
---
 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 mbox series

Patch

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::
 diff.external::
 	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
 excluded.
 
 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`.
 
 OPTIONS
 -------
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.
 
 --all::
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'
 'blame'::
 	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
 
 'info'::
 	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.