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

[PATCH 2/2] Documentation/i18n: quote double-dash for AsciiDoc

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Jun 29, 2011, 05:36 UTC
Message-ID
<20110629053648.GD28690@elie>
In-Reply-To
<20110629053133.GB28690@elie>

As explained in v1.7.3-rc0~13^2 (Work around em-dash handling in newer AsciiDoc, 2010-08-23), if double dashes in names of commands are not escaped, AsciiDoc renders them as em dashes.

While fixing that, spell the command name as "git sh-i18n--envsubst" (2 words) instead of emphasizing the name of the binary (one hyphenated name) and format it in italics.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Thanks for reading.
 Documentation/git-sh-i18n--envsubst.txt |    6 +++---
 Documentation/git-sh-i18n.txt           |    2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-sh-i18n--envsubst.txt b/Documentation/git-sh-i18n--envsubst.txt
index 61e4c08d..6e3a9539 100644
--- a/Documentation/git-sh-i18n--envsubst.txt
+++ b/Documentation/git-sh-i18n--envsubst.txt
@@ -10,8 +10,8 @@ SYNOPSIS
 [verse]
 eval_gettext () {
 	printf "%s" "$1" | (
-		export PATH $('git sh-i18n--envsubst' --variables "$1");
-		'git sh-i18n--envsubst' "$1"
+		export PATH $('git sh-i18n{litdd}envsubst' --variables "$1");
+		'git sh-i18n{litdd}envsubst' "$1"
 	)
 }
 
@@ -22,7 +22,7 @@ This is not a command the end user would want to run.  Ever.
 This documentation is meant for people who are studying the
 plumbing scripts and/or are writing new ones.
 
-git-sh-i18n--envsubst is Git's stripped-down copy of the GNU
+'git sh-i18n{litdd}envsubst' is Git's stripped-down copy of the GNU
 `envsubst(1)` program that comes with the GNU gettext package. It's
 used internally by linkgit:git-sh-i18n[1] to interpolate the variables
 passed to the the `eval_gettext` function.
diff --git a/Documentation/git-sh-i18n.txt b/Documentation/git-sh-i18n.txt
index 3b1f7ac7..eca69e3d 100644
--- a/Documentation/git-sh-i18n.txt
+++ b/Documentation/git-sh-i18n.txt
@@ -34,7 +34,7 @@ gettext::
 eval_gettext::
 	Currently a dummy fall-through function implemented as a wrapper
 	around `printf(1)` with variables expanded by the
-	linkgit:git-sh-i18n--envsubst[1] helper. Will be replaced by a
+	linkgit:git-sh-i18n{litdd}envsubst[1] helper. Will be replaced by a
 	real gettext implementation in a later version.
 
 GIT
-- 
1.7.6
Previous: Jonathan NiederNext: Ævar Arnfjörð Bjarmason
Message 7 of 9 in “Documentation: quote double-dash in "<commit> -- <filename>" for AsciiDoc”
  1. Documentation: quote double-dash in "<commit> -- <filename>" for AsciiDocJonathan Nieder, Jun 28, 2011
  2. Junio C HamanoJun 28, 2011
  3. Jonathan NiederJun 29, 2011
  4. Jeff KingJun 28, 2011
  5. 0/2 Documentation: quote double-dash for AsciiDocJonathan Nieder, Jun 29, 2011
  6. 1/2 Documentation: quote double-dash for AsciiDocJonathan Nieder, Jun 29, 2011
  7. 2/2 Documentation/i18n: quote double-dash for AsciiDocJonathan Nieder, Jun 29, 2011
  8. Ævar Arnfjörð BjarmasonJun 29, 2011
  9. fixup! Documentation/i18n: quote double-dash for AsciiDocJonathan Nieder, Jun 29, 2011

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.