git/Documentation/git-sh-i18n--envsubst.txt
Ævar Arnfjörð Bjarmason f5008f56d5 git-sh-i18n--envsubst: add SYNOPSIS section to the documentation
Change the documentation for the git-sh-i18n--envsubst program to
include a SYNOPSIS section. Include the invocation of the program from
git-sh-i18n.sh.

Not having a SYNOPSIS section caused the "doc" target to fail on
Centos 5.5 with asciidoc 8.2.5, while building with 8.6.4 on Debian
works just fine.

The relevant error was:

    ERROR: git-sh-i18n--envsubst.txt: line 9: second section must be named SYNOPSIS

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-05-30 01:08:32 -07:00

37 lines
905 B
Plaintext

git-sh-i18n--envsubst(1)
========================
NAME
----
git-sh-i18n--envsubst - Git's own envsubst(1) for i18n fallbacks
SYNOPSIS
--------
[verse]
eval_gettext () {
printf "%s" "$1" | (
export PATH $('git sh-i18n--envsubst' --variables "$1");
'git sh-i18n--envsubst' "$1"
)
}
DESCRIPTION
-----------
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
`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.
No promises are made about the interface, or that this
program won't disappear without warning in the next version
of Git. Don't use it.
GIT
---
Part of the linkgit:git[1] suite