From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH 4/5] gettext docs: the git-sh-i18n.sh Shell interface
Date: Fri, 10 Sep 2010 19:35:52 +0000 [thread overview]
Message-ID: <1284147353-18000-5-git-send-email-avarab@gmail.com> (raw)
In-Reply-To: <AANLkTikdHZFmXAdABvS9hPXtbXNJU5NdCOrw5_KP73bX@mail.gmail.com>
Change po/README's "Marking strings for translation" section so that
it covers the git-sh-i18n.sh Shell interface.
The existing documentation in git-sh-i18n.sh has been moved to the
README file, to avoid them drifting in apart..
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
git-sh-i18n.sh | 16 ++--------------
po/README | 23 +++++++++++++++++++++++
2 files changed, 25 insertions(+), 14 deletions(-)
diff --git a/git-sh-i18n.sh b/git-sh-i18n.sh
index b8b645a..f8dd43a 100644
--- a/git-sh-i18n.sh
+++ b/git-sh-i18n.sh
@@ -2,20 +2,8 @@
#
# Copyright (c) 2010 Ævar Arnfjörð Bjarmason
#
-# This is Git's interface to gettext.sh. Use it right after
-# git-sh-setup as:
-#
-# . git-sh-setup
-# . git-sh-i18n
-#
-# # For constant interface messages:
-# gettext "A message for the user"; echo
-#
-# # To interpolate variables:
-# details="oh noes"
-# eval_gettext "An error occured: \$details"; echo
-#
-# See "info '(gettext)sh'" for the full manual.
+# This is Git's interface to gettext.sh. See po/README for usage
+# instructions.
# Export the TEXTDOMAIN* data that we need for Git
TEXTDOMAIN=git
diff --git a/po/README b/po/README
index ac12637..513cf32 100644
--- a/po/README
+++ b/po/README
@@ -155,3 +155,26 @@ C:
Here _() couldn't have statically determined what the translation
string will be, but since it was already marked for translation
with N_() the look-up in the message catalog will succeed.
+
+Shell:
+
+ - The Git gettext shell interface is just a wrapper for
+ gettext.sh. Import it right after git-sh-setup like this:
+
+ . git-sh-setup
+ . git-sh-i18n
+
+ And then use the gettext or eval_gettext functions:
+
+ # For constant interface messages:
+ gettext "A message for the user"; echo
+
+ # To interpolate variables:
+ details="oh noes"
+ eval_gettext "An error occured: \$details"; echo
+
+ More documentation about the interface is available in the GNU info
+ page: `info '(gettext)sh'`. Looking at git-am.sh (the first shell
+ command to be translated) for examples is also useful:
+
+ git log --reverse -p --grep=gettextize git-am.sh
--
1.7.2.3.313.gcd15
next prev parent reply other threads:[~2010-09-10 19:36 UTC|newest]
Thread overview: 47+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-09-07 16:45 [PATCH 00/20] [CONTINUE] Add gettext support to Git Ævar Arnfjörð Bjarmason
2010-09-07 16:45 ` [PATCH 01/20] gettextize: git-clean clean.requireForce braces Ævar Arnfjörð Bjarmason
2010-09-07 16:45 ` [PATCH 02/20] gettextize: git-clone "Cloning into" message braces Ævar Arnfjörð Bjarmason
2010-09-07 16:47 ` [PATCH 04/20] Makefile: add GNU_GETTEXT, set when we expect GNU gettext Ævar Arnfjörð Bjarmason
2010-09-07 16:47 ` [PATCH 05/20] Makefile: MSGFMT="msgfmt --check" under GNU_GETTEXT Ævar Arnfjörð Bjarmason
2010-09-07 16:47 ` [PATCH 06/20] Revert "gettextize: git-revert mark the "me" variable for translation" Ævar Arnfjörð Bjarmason
2010-09-07 16:47 ` [PATCH 07/20] gettextize: git-revert "Your local changes" message Ævar Arnfjörð Bjarmason
2010-09-07 16:47 ` [PATCH 08/20] gettextize: git-revert literal "me" messages Ævar Arnfjörð Bjarmason
2010-09-07 16:47 ` [PATCH 09/20] gettext: add GETTEXT_POISON support for shell scripts Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 10/20] gettext: add GETTEXT_POISON tests " Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 11/20] gettextize: git-am add git-sh-i18n Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 12/20] gettextize: git-am one-line gettext $msg; echo Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 13/20] gettextize: git-am multi-line getttext " Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 14/20] gettextize: git-am eval_gettext messages Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 15/20] gettextize: git-am die messages Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 16/20] gettextize: git-am cannot_fallback messages Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 17/20] gettextize: git-am clean_abort messages Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 18/20] gettextize: git-am "Apply?" message Ævar Arnfjörð Bjarmason
2010-09-07 16:48 ` [PATCH 19/20] gettextize: git-am core say messages Ævar Arnfjörð Bjarmason
2010-09-07 16:50 ` [PATCH 20/20] gettextize: git-am printf(1) message to eval_gettext Ævar Arnfjörð Bjarmason
2010-09-07 20:10 ` Jonathan Nieder
2010-09-07 20:29 ` Ævar Arnfjörð Bjarmason
2010-09-07 20:32 ` Jonathan Nieder
2010-09-07 20:46 ` [PATCH v2 " Ævar Arnfjörð Bjarmason
2010-09-07 20:45 ` [PATCH v2 19/20] gettextize: git-am core say messages Ævar Arnfjörð Bjarmason
2010-09-08 16:43 ` [PATCH 00/20] [CONTINUE] Add gettext support to Git Junio C Hamano
2010-09-08 23:32 ` Ævar Arnfjörð Bjarmason
2010-09-10 12:00 ` Ævar Arnfjörð Bjarmason
2010-09-10 16:01 ` Junio C Hamano
2010-09-10 17:17 ` Ævar Arnfjörð Bjarmason
2010-09-10 19:35 ` [PATCH 0/5] gettext docs: programmer docs in po/README Ævar Arnfjörð Bjarmason
2010-09-10 23:21 ` Ævar Arnfjörð Bjarmason
2010-09-10 19:35 ` [PATCH 1/5] gettext docs: add a "Testing your changes" section to po/README Ævar Arnfjörð Bjarmason
2010-09-10 19:35 ` [PATCH 2/5] gettext docs: add "Marking strings for translation" section in po/README Ævar Arnfjörð Bjarmason
2010-09-10 22:26 ` Junio C Hamano
2010-09-10 22:31 ` Ævar Arnfjörð Bjarmason
2010-09-10 19:35 ` [PATCH 3/5] gettext docs: the gettext.h C interface Ævar Arnfjörð Bjarmason
2010-09-10 22:30 ` Junio C Hamano
2010-09-10 22:53 ` Ævar Arnfjörð Bjarmason
2010-09-10 22:52 ` Junio C Hamano
2010-09-10 23:03 ` Ævar Arnfjörð Bjarmason
2010-09-10 23:06 ` Junio C Hamano
2010-09-10 23:16 ` Ævar Arnfjörð Bjarmason
2010-09-10 19:35 ` Ævar Arnfjörð Bjarmason [this message]
2010-09-10 22:54 ` [PATCH 4/5] gettext docs: the git-sh-i18n.sh Shell interface Junio C Hamano
2010-09-10 22:58 ` Ævar Arnfjörð Bjarmason
2010-09-10 19:35 ` [PATCH 5/5] gettext docs: the Git::I18N Perl interface Ævar Arnfjörð Bjarmason
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=1284147353-18000-5-git-send-email-avarab@gmail.com \
--to=avarab@gmail.com \
--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).