git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: "Wesley J. Landaker" <wjl@icecavern.net>
Cc: Junio C Hamano <gitster@pobox.com>,
	git@vger.kernel.org, Eric Wong <normalperson@yhbt.net>
Subject: Re: [PATCH 1/2] Documentation: git-svn: fix spurious bolding that mangles the output
Date: Wed, 22 Apr 2009 11:15:16 -0400	[thread overview]
Message-ID: <20090422151515.GA12370@coredump.intra.peff.net> (raw)
In-Reply-To: <1240411907-5002-1-git-send-email-wjl@icecavern.net>

On Wed, Apr 22, 2009 at 08:51:46AM -0600, Wesley J. Landaker wrote:

> Without this fix, the output looks like:
> 
> "Keep in mind that the  (asterisk) wildcard of the local ref (right of
> the :) *must be the ..." -- with half the sentence spuriously bold.
> 
> This is probably working around an asciidoc bug, but it's better to fix
> this than to leave the documentation in an unreadable state.

I think it's a documentation bug; the asterisk is a special character,
so it is seeing the first one as the start of bold, instead of the one
on the left side of *must*.

>  Keep in mind that the '*' (asterisk) wildcard of the local ref
> -(right of the ':') *must* be the farthest right path component;
> +(right of the ':') must be the farthest right path component;

So the right fix is probably to quote the asterisk that is not part of
the bolding, like:

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 9229d45..3e22e40 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -693,7 +693,7 @@ listed below are allowed:
 	tags = tags/*/project-a:refs/remotes/project-a/tags/*
 ------------------------------------------------------------------------
 
-Keep in mind that the '*' (asterisk) wildcard of the local ref
+Keep in mind that the '\*' (asterisk) wildcard of the local ref
 (right of the ':') *must* be the farthest right path component;
 however the remote wildcard may be anywhere as long as it's own
 independent path component (surrounded by '/' or EOL).   This

  parent reply	other threads:[~2009-04-22 15:16 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-04-22 14:51 [PATCH 1/2] Documentation: git-svn: fix spurious bolding that mangles the output Wesley J. Landaker
2009-04-22 14:51 ` [PATCH 2/2] Documentation: git-svn: fix a grammatical error without awkwardness Wesley J. Landaker
2009-04-22 15:15 ` Jeff King [this message]
2009-04-22 15:48   ` [PATCH v2 1/2] Documentation: git-svn: fix spurious bolding that mangles the output Wesley J. Landaker
2009-04-23  4:21     ` Junio C Hamano
2009-04-22 15:48   ` [PATCH v2 2/2] Documentation: git-svn: fix a grammatical error without awkwardness Wesley J. Landaker

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=20090422151515.GA12370@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=normalperson@yhbt.net \
    --cc=wjl@icecavern.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 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).