git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Subject: [PATCH 1/2] Documentation/config/checkout: replace sq with backticks
Date: Sun,  4 Oct 2020 04:18:23 -0700	[thread overview]
Message-ID: <f08d3f796a806b5ec20f12cc85683b2c2e99b1a8.1601810233.git.liu.denton@gmail.com> (raw)
In-Reply-To: <cover.1601810233.git.liu.denton@gmail.com>

The modern style for Git documentation is to use backticks to quote
any command-line documenation so that it is typeset in monospace.
Replace all single quotes with backticks to conform to this.

Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
 Documentation/config/checkout.txt | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt
index 6b646813ab..e3684a5459 100644
--- a/Documentation/config/checkout.txt
+++ b/Documentation/config/checkout.txt
@@ -1,18 +1,18 @@
 checkout.defaultRemote::
-	When you run 'git checkout <something>'
-	or 'git switch <something>' and only have one
+	When you run `git checkout <something>`
+	or `git switch <something>` and only have one
 	remote, it may implicitly fall back on checking out and
-	tracking e.g. 'origin/<something>'. This stops working as soon
-	as you have more than one remote with a '<something>'
+	tracking e.g. `origin/<something>`. This stops working as soon
+	as you have more than one remote with a `<something>`
 	reference. This setting allows for setting the name of a
 	preferred remote that should always win when it comes to
 	disambiguation. The typical use-case is to set this to
 	`origin`.
 +
 Currently this is used by linkgit:git-switch[1] and
-linkgit:git-checkout[1] when 'git checkout <something>'
-or 'git switch <something>'
-will checkout the '<something>' branch on another remote,
-and by linkgit:git-worktree[1] when 'git worktree add' refers to a
+linkgit:git-checkout[1] when `git checkout <something>`
+or `git switch <something>`
+will checkout the `<something>` branch on another remote,
+and by linkgit:git-worktree[1] when `git worktree add` refers to a
 remote branch. This setting might be used for other checkout-like
 commands or functionality in the future.
-- 
2.28.0.942.g77c4c6094c


  reply	other threads:[~2020-10-04 11:20 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-04 11:18 [PATCH 0/2] checkout: learn the checkout.guess config variable Denton Liu
2020-10-04 11:18 ` Denton Liu [this message]
2020-10-04 11:18 ` [PATCH 2/2] checkout: learn to respect checkout.guess Denton Liu
2020-10-04 17:46   ` Junio C Hamano
2020-10-06  8:07     ` Denton Liu
2020-10-06 18:41       ` Junio C Hamano
2020-10-06 19:31         ` Johannes Schindelin
2020-10-07  5:09 ` [PATCH v2 0/2] checkout: learn the checkout.guess config variable Denton Liu
2020-10-07  5:09   ` [PATCH v2 1/2] Documentation/config/checkout: replace sq with backticks Denton Liu
2020-10-07  5:09   ` [PATCH v2 2/2] checkout: learn to respect checkout.guess Denton Liu
2020-10-07 16:47     ` Junio C Hamano
2020-10-08  5:48   ` [PATCH v3 0/2] checkout: learn the checkout.guess config variable Denton Liu
2020-10-08  5:48     ` [PATCH v3 1/2] Documentation/config/checkout: replace sq with backticks Denton Liu
2020-10-08  5:48     ` [PATCH v3 2/2] checkout: learn to respect checkout.guess Denton Liu

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:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

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

  git send-email \
    --in-reply-to=f08d3f796a806b5ec20f12cc85683b2c2e99b1a8.1601810233.git.liu.denton@gmail.com \
    --to=liu.denton@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* 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.
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 NNTP newsgroup(s).