Skip to content

Commit 27269fc

Browse files
jrngitster
authored andcommitted
Documentation/i18n: quote double-dash for AsciiDoc
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. The double-dash in the title should be escaped, too, to avoid spurious em dashes in the header: .TH "GIT\-SH\-I18N\(emENVSUB" "1" "06/26/2011" "Git 1\&.7\&.6" "Git Manual" AsciiDoc 8.6.4 with DocBook XSL 1.76.0-RC1 copes fine and writes "GIT\-SH\-I18N\-\-ENVSUB" even without this change, which is why it was missed before. Signed-off-by: Jonathan Nieder <[email protected]> Acked-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 347231f commit 27269fc

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

Documentation/git-sh-i18n--envsubst.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
git-sh-i18n--envsubst(1)
2-
========================
1+
git-sh-i18n{litdd}envsubst(1)
2+
=============================
33

44
NAME
55
----
@@ -10,8 +10,8 @@ SYNOPSIS
1010
[verse]
1111
eval_gettext () {
1212
printf "%s" "$1" | (
13-
export PATH $('git sh-i18n--envsubst' --variables "$1");
14-
'git sh-i18n--envsubst' "$1"
13+
export PATH $('git sh-i18n{litdd}envsubst' --variables "$1");
14+
'git sh-i18n{litdd}envsubst' "$1"
1515
)
1616
}
1717

@@ -22,7 +22,7 @@ This is not a command the end user would want to run. Ever.
2222
This documentation is meant for people who are studying the
2323
plumbing scripts and/or are writing new ones.
2424

25-
git-sh-i18n--envsubst is Git's stripped-down copy of the GNU
25+
'git sh-i18n{litdd}envsubst' is Git's stripped-down copy of the GNU
2626
`envsubst(1)` program that comes with the GNU gettext package. It's
2727
used internally by linkgit:git-sh-i18n[1] to interpolate the variables
2828
passed to the the `eval_gettext` function.

Documentation/git-sh-i18n.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ gettext::
3434
eval_gettext::
3535
Currently a dummy fall-through function implemented as a wrapper
3636
around `printf(1)` with variables expanded by the
37-
linkgit:git-sh-i18n--envsubst[1] helper. Will be replaced by a
37+
linkgit:git-sh-i18n{litdd}envsubst[1] helper. Will be replaced by a
3838
real gettext implementation in a later version.
3939

4040
GIT

0 commit comments

Comments
 (0)