All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: "Ramkumar Ramachandra" <artagnon@gmail.com>,
	"Frédéric Brière" <fbriere@fbriere.net>,
	"Christian Couder" <chriscool@tuxfamily.org>,
	"Thomas Rast" <trast@student.ethz.ch>
Subject: [PATCH 12/17] Documentation: remove stray backslashes in rev-parse manual
Date: Fri, 20 Aug 2010 05:35:03 -0500	[thread overview]
Message-ID: <20100820103503.GL10407@burratino> (raw)
In-Reply-To: <20100820101902.GA10356@burratino>

Use the {asterisk} entity instead of \* or * to avoid both
stray backslashes in output and suppression of asterisks
misinterpreted as a bold-text delimiter.

Reported-by: Frédéric Brière <fbriere@fbriere.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
 Documentation/git-rev-parse.txt |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index be4c053..341ca90 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -74,7 +74,7 @@ OPTIONS
 	properly quoted for consumption by shell.  Useful when
 	you expect your parameter to contain whitespaces and
 	newlines (e.g. when using pickaxe `-S` with
-	'git diff-\*'). In contrast to the `--sq-quote` option,
+	'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
 	the command input is still interpreted as usual.
 
 --not::
@@ -112,14 +112,15 @@ OPTIONS
 +
 If a `pattern` is given, only refs matching the given shell glob are
 shown.  If the pattern does not contain a globbing character (`?`,
-`\*`, or `[`), it is turned into a prefix match by appending `/\*`.
+`{asterisk}`, or `[`), it is turned into a prefix match by
+appending `/{asterisk}`.
 
 --glob=pattern::
 	Show all refs matching the shell glob pattern `pattern`. If
 	the pattern does not start with `refs/`, this is automatically
 	prepended.  If the pattern does not contain a globbing
-	character (`?`, `\*`, or `[`), it is turned into a prefix
-	match by appending `/\*`.
+	character (`?`, `{asterisk}`, or `[`), it is turned into a prefix
+	match by appending `/{asterisk}`.
 
 --show-toplevel::
 	Show the absolute path of the top-level directory.
-- 
1.7.2.2.536.g42dab.dirty

  parent reply	other threads:[~2010-08-20 10:36 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-08-20 10:19 [RFC/PATCH 00/17] unexpected backslashes in man pages Jonathan Nieder
2010-08-20 10:20 ` [PATCH 01/17] Documentation: tweak description of log.date Jonathan Nieder
2010-08-20 10:21 ` [PATCH 02/17] Documentation: quoting trouble in "git rm" discussion Jonathan Nieder
2010-08-20 10:23 ` [PATCH 03/17] Documentation: unbreak regex in show-ref manual Jonathan Nieder
2010-08-20 10:26 ` [PATCH 04/17] Documentation: clarify quoting in "git add" example Jonathan Nieder
2010-08-20 10:28 ` [PATCH 05/17] Documentation: add missing quotes to "git grep" examples Jonathan Nieder
2010-08-20 10:30 ` [PATCH 06/17] Documentation: clarify quoting in "git rm" example Jonathan Nieder
2010-08-20 10:30 ` [PATCH 07/17] Documentation: clarify quoting in gitignore docs Jonathan Nieder
2010-08-20 10:31 ` [PATCH 08/17] Documentation: remove backslashes in manpage synopses Jonathan Nieder
2010-08-20 10:32 ` [PATCH 09/17] Documentation/technical: avoid stray backslash in parse-options API docs Jonathan Nieder
2010-08-20 10:33 ` [PATCH 10/17] Documentation: remove stray backslash from "git bundle" manual Jonathan Nieder
2010-08-20 10:34 ` [PATCH 11/17] Documentation: remove backslash before ~ in fast-import manual Jonathan Nieder
2010-08-20 10:35 ` Jonathan Nieder [this message]
2010-08-20 10:37 ` [PATCH 13/17] Documentation: remove stray backslash in show-branch discussion Jonathan Nieder
2010-08-23 11:18   ` Thomas Rast
2010-08-23 11:36     ` Ramkumar Ramachandra
2010-08-23 22:49     ` Jonathan Nieder
2010-08-20 10:37 ` [PATCH 14/17] Documentation: avoid stray backslashes in core tutorial Jonathan Nieder
2010-08-20 10:38 ` [PATCH 15/17] Documentation: avoid stray backslash in user manual Jonathan Nieder
2010-08-20 10:39 ` [PATCH 16/17] Documentation: do not convert ... operator to ellipses Jonathan Nieder
2010-08-20 10:40 ` [PATCH 17/17] Documentation: remove stray backslashes from "Fighting regressions" article Jonathan Nieder
2010-08-23 11:51 ` [RFC/PATCH 00/17] unexpected backslashes in man pages Thomas Rast

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=20100820103503.GL10407@burratino \
    --to=jrnieder@gmail.com \
    --cc=artagnon@gmail.com \
    --cc=chriscool@tuxfamily.org \
    --cc=fbriere@fbriere.net \
    --cc=git@vger.kernel.org \
    --cc=trast@student.ethz.ch \
    /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.