From: Thomas Rast <trast@student.ethz.ch>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] Documentation: Quote ~(s) causing subscript
Date: Mon, 15 Sep 2008 11:19:56 +0200 [thread overview]
Message-ID: <1221470398-8698-1-git-send-email-trast@student.ethz.ch> (raw)
This is actually not a series, but a choice. I noticed that
git-bundle.html has a stray subscript in the first paragraph of
'Specifying References', so here are two options:
* Documenation: git-bundle: quote tildes that cause subscript
The minimal-impact change. Quotes just enough tildes in that
paragraph to avoid the subscript.
* Documentation: replace [^~] with escapes everywhere
The global change. Quotes all tildes and carets to avoid any future
confusion.
I like the global change better, because any tilde or caret is a
possible future pitfall: it will trigger a sub/superscript as soon as
a matching delimiter is added within the same paragraph. But of
course it makes the ascii non-markup less readable as plain text.
Searching through history and list archives didn't exactly help: as
early as babfaba (Fix usage of carets in git-rev-parse(1),
2005-10-05), the {caret} was established. However, in a thread on
precisely the paragraph in git-bundle.txt I'm trying to fix,
http://thread.gmane.org/gmane.comp.version-control.git/50761
the discussion turned to trying to figure out a consistent asciidoc
behaviour -- and from there, style guide -- but died. The patch
apparently never made it into git.git in either the \~ or the {tilde}
form.
- Thomas
next reply other threads:[~2008-09-15 9:21 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-09-15 9:19 Thomas Rast [this message]
2008-09-15 9:19 ` [PATCH] Documenation: git-bundle: quote tildes that cause subscript Thomas Rast
2008-09-15 9:19 ` [PATCH] Documentation: replace [^~] with escapes everywhere Thomas Rast
2008-09-15 23:56 ` Avery Pennarun
2008-09-16 0:05 ` Thomas Rast
2008-09-16 0:10 ` Avery Pennarun
2008-09-16 8:24 ` Junio C Hamano
2008-09-16 12:47 ` [PATCH] Documentation: disable sub/superscript characters ^/~ Thomas Rast
2008-09-16 15:58 ` [PATCH] Documentation: replace [^~] with escapes everywhere Avery Pennarun
2008-09-16 16:34 ` Junio C Hamano
2008-09-16 16:48 ` Junio C Hamano
2008-09-16 19:12 ` Jeff King
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=1221470398-8698-1-git-send-email-trast@student.ethz.ch \
--to=trast@student.ethz.ch \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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).