git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] Documentation: Quote ~(s) causing subscript

From
Thomas Rast <trast@student.ethz.ch>
Date
Sep 15, 2008, 09:19 UTC
Message-ID
<1221470398-8698-1-git-send-email-trast@student.ethz.ch>

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: Thomas Rast
Message 1 of 12 in “Documentation: Quote ~(s) causing subscript”
  1. Documentation: Quote ~(s) causing subscriptThomas Rast, Sep 15, 2008
  2. Documenation: git-bundle: quote tildes that cause subscriptThomas Rast, Sep 15, 2008
  3. Documentation: replace [^~] with escapes everywhereThomas Rast, Sep 15, 2008
  4. Avery PennarunSep 15, 2008
  5. Thomas RastSep 16, 2008
  6. Avery PennarunSep 16, 2008
  7. Junio C HamanoSep 16, 2008
  8. Documentation: disable sub/superscript characters ^/~Thomas Rast, Sep 16, 2008
  9. Avery PennarunSep 16, 2008
  10. Junio C HamanoSep 16, 2008
  11. Junio C HamanoSep 16, 2008
  12. Jeff KingSep 16, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.