git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Thomas Rast <trast@student.ethz.ch>
To: Miklos Vajna <vmiklos@frugalware.org>
Cc: bill lam <cbill.lam@gmail.com>, git <git@vger.kernel.org>
Subject: Re: quote in help code example
Date: Thu, 15 Oct 2009 14:02:55 +0200	[thread overview]
Message-ID: <200910151402.56295.trast@student.ethz.ch> (raw)
In-Reply-To: <200910132215.46840.trast@student.ethz.ch>

Thomas Rast wrote:
> 
> The patch below just replaces said template with a no-op for git's
> manpage creation.  I have not been able to substantiate the claim that
> apostrophes are special, and in fact with the patch my manpages look
> fine.  Then again I don't know anything about roff syntax either, and
> manuals seem a bit hard to come by.

Actually, scratch the patch.  I haven't been able to nail it yet, and
I'm not sure I have the energy for another stab at this mess; but
during testing with older versions, I learned that they behave
differently and the patch just shifts the breakage a bit.

Also, the single quotes are apparently special at the beginning of a
line and to delimit function arguments, though not elsewhere.  The
bash manpage uses \(aq to get a literal apostrophe, which I will aim
to convert them to.  Oddly enough, the groff(7) manpage does not
document \(aq, but lists \(cq as the official escape for ' ... which
then turns out to mutate into this cursed non-apostrophe again.  Sigh.

-- 
Thomas Rast
trast@{inf,student}.ethz.ch

  reply	other threads:[~2009-10-15 12:07 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-10-12 10:29 bill lam
2009-10-12 19:40 ` Miklos Vajna
2009-10-13  2:16   ` bill lam
2009-10-13 10:19     ` Miklos Vajna
2009-10-13 14:06       ` bill lam
2009-10-13 15:30         ` Miklos Vajna
2009-10-13 20:15           ` Thomas Rast
2009-10-15 12:02             ` Thomas Rast [this message]
2009-10-21  8:24               ` [PATCH] Quote ' as \(aq in manpages Thomas Rast
2009-10-21 10:38                 ` Miklos Vajna
2009-10-21 18:01                 ` Anders Kaseorg
2009-10-21 18:57                   ` [PATCH v2] " Thomas Rast
2009-10-21 21:31                     ` [PATCH] Document GNU_ROFF in Makefile Miklos Vajna
2009-10-21 22:22                       ` Junio C Hamano
2009-10-21 22:51                         ` Anders Kaseorg
2009-10-22  8:19                           ` [PATCH v3] Quote ' as \(aq in manpages Thomas Rast
2009-10-21 21:42                     ` [PATCH v2] " Anders Kaseorg
2009-10-12 21:06 ` quote in help code example Junio C Hamano

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=200910151402.56295.trast@student.ethz.ch \
    --to=trast@student.ethz.ch \
    --cc=cbill.lam@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=vmiklos@frugalware.org \
    --subject='Re: quote in help code example' \
    /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

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).