All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: Jeff King <peff@peff.net>
Subject: [PATCH 1/4] doc: convert \--option to --option
Date: Tue, 17 Apr 2018 21:15:26 +0200	[thread overview]
Message-ID: <e17f2ec4e78266a789c9c48c6afefdf53e15b7d5.1523991648.git.martin.agren@gmail.com> (raw)
In-Reply-To: <cover.1523991648.git.martin.agren@gmail.com>

Rather than using a backslash in \--foo, with or without ''-quoting,
write `--foo` for better rendering. As explained in commit 1c262bb7b
(doc: convert \--option to --option, 2015-05-13), the backslash is not
needed for the versions of AsciiDoc that we support, but is rendered
literally by Asciidoctor.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git-format-patch.txt | 2 +-
 Documentation/git-push.txt         | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 6cbe462a77..b41e1329a7 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -47,7 +47,7 @@ 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
-history up until <commit>, use the '\--root' option: `git format-patch
+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>`.
 
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 5b08302fc2..34410f9fca 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -300,7 +300,7 @@ origin +master` to force a push to the `master` branch). See the
 	These options are passed to linkgit:git-send-pack[1]. A thin transfer
 	significantly reduces the amount of sent data when the sender and
 	receiver share many of the same objects in common. The default is
-	\--thin.
+	`--thin`.
 
 -q::
 --quiet::
-- 
2.17.0.252.gfe0a9eaf31


  reply	other threads:[~2018-04-17 19:15 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-03-10 11:52 [PATCH 0/3] shortlog: do not accept revisions when run outside repo Martin Ågren
2018-03-10 11:52 ` [PATCH 1/3] git-shortlog.txt: reorder usages Martin Ågren
2018-03-13 19:19   ` Junio C Hamano
2018-03-10 11:52 ` [PATCH 2/3] shortlog: add usage-string for stdin-reading Martin Ågren
2018-03-10 11:52 ` [PATCH 3/3] shortlog: do not accept revisions when run outside repo Martin Ågren
2018-03-13 19:56   ` Jonathan Nieder
2018-03-13 20:47     ` Martin Ågren
2018-03-13 21:36       ` Jonathan Nieder
2018-03-13 21:46   ` Junio C Hamano
2018-03-14  5:06     ` Martin Ågren
2018-03-14 21:34 ` [PATCH v2 0/3] shortlog: disallow left-over arguments " Martin Ågren
2018-03-14 21:34   ` [PATCH v2 1/3] git-shortlog.txt: reorder usages Martin Ågren
2018-03-14 21:34   ` [PATCH v2 2/3] shortlog: add usage-string for stdin-reading Martin Ågren
2018-03-14 21:34   ` [PATCH v2 3/3] shortlog: disallow left-over arguments outside repo Martin Ågren
2018-03-28  8:48 ` [PATCH 0/3] shortlog: do not accept revisions when run " Jeff King
2018-03-28 12:24   ` Martin Ågren
2018-04-17 19:15     ` [PATCH 0/4] doc: cleaning up instances of \-- Martin Ågren
2018-04-17 19:15       ` Martin Ågren [this message]
2018-04-17 19:15       ` [PATCH 2/4] doc: convert [\--] to [--] Martin Ågren
2018-04-17 19:15       ` [PATCH 3/4] git-[short]log.txt: unify quoted standalone -- Martin Ågren
2018-04-17 19:15       ` [PATCH 4/4] git-submodule.txt: quote usage in monospace, drop backslash Martin Ågren
2018-04-18  4:24       ` [PATCH 0/4] doc: cleaning up instances of \-- Junio C Hamano
2018-05-10  7:11         ` Jeff King
2018-04-19  1:25       ` brian m. carlson

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=e17f2ec4e78266a789c9c48c6afefdf53e15b7d5.1523991648.git.martin.agren@gmail.com \
    --to=martin.agren@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.