diff mbox series

[1/3] po/README: document PO helper

Message ID 20210311125511.51152-2-bagasdotme@gmail.com (mailing list archive)
State New, archived
Headers show
Series po/README: document miscellaneous topics mentioned by l10n coordinator | expand

Commit Message

Bagas Sanjaya March 11, 2021, 12:55 p.m. UTC
Document about PO helper script (po-helper.sh). It covers about
installing the script and short usage examples.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 po/README | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

Comments

Jiang Xin March 12, 2021, 1:32 a.m. UTC | #1
Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道:
>
> Document about PO helper script (po-helper.sh). It covers about
> installing the script and short usage examples.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  po/README | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>
> diff --git a/po/README b/po/README
> index efd5baaf1d..9beffc2954 100644
> --- a/po/README
> +++ b/po/README
> @@ -286,3 +286,25 @@ Testing marked strings
>
>  Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
>  changed to account for translations as they're added.
> +
> +
> +PO Helper
> +---------
> +
> +To make maintaining XX.po file easier, the l10n coordinator created
> +po-helper.sh script. It is wrapper to gettext suite, specifically

It's better to rename the script to other name without the suffix
".sh", so we can reimplement it in other programming language. Maybe
we can rename it to `git-po-helper`, and host this helper in a
separate project on GitHub.


> +written for the purpose of Git l10n workflow.
> +
> +To install the script, checkout "po-helper" branch, then copy
> +utils/po-helper.sh to somewhere on $PATH, and mark it executable.
> +
> +Below are the usage examples:
> +
> +  - To start new language translation:
> +        po-helper.sh init XX.po
> +  - To update PO file:
> +        po-helper.sh update XX.po
> +  - To syntax check:
> +        po-helper.sh check XX.po
> +
> +Run po-helper.sh without arguments for usage help.
> --
> 2.25.1
>
Junio C Hamano March 12, 2021, 6:03 a.m. UTC | #2
Jiang Xin <worldhello.net@gmail.com> writes:

> Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道:
>>
>> Document about PO helper script (po-helper.sh). It covers about
>> installing the script and short usage examples.
>>
>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>> ---
>>  po/README | 22 ++++++++++++++++++++++
>>  1 file changed, 22 insertions(+)
>>
>> diff --git a/po/README b/po/README
>> index efd5baaf1d..9beffc2954 100644
>> --- a/po/README
>> +++ b/po/README
>> @@ -286,3 +286,25 @@ Testing marked strings
>>
>>  Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
>>  changed to account for translations as they're added.
>> +
>> +
>> +PO Helper
>> +---------
>> +
>> +To make maintaining XX.po file easier, the l10n coordinator created
>> +po-helper.sh script. It is wrapper to gettext suite, specifically
>
> It's better to rename the script to other name without the suffix
> ".sh", so we can reimplement it in other programming language. Maybe
> we can rename it to `git-po-helper`, and host this helper in a
> separate project on GitHub.

It might be a good move in the longer term, but if the po-helper.sh
is working well enough to fill the need of i18n/l10n team right now,
I think documenting the status quo would be a good way to help the
contributors immediately.

And when we reimplement it (if that is desirable---I have no opinion
myself), we certainly would want to update this part of the doc to
use the name of the rewritten tool.

In any case, I expect that you to be the main reviewer on this topic
and you will feed me the final commits, just like any other change
in the po/* area via a pull request.  In other words, I may have
input to the discussion on list, but I won't be applying the result
myself---I'll be pulling from git://github.com/git-l10n/git-po.git
repository instead.

Thanks.
Bagas Sanjaya March 12, 2021, 11:56 a.m. UTC | #3
On 12/03/21 13.03, Junio C Hamano wrote:
> Jiang Xin <worldhello.net@gmail.com> writes:
> 
>> Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道:
>>>
>>> Document about PO helper script (po-helper.sh). It covers about
>>> installing the script and short usage examples.
>>>
>>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>>> ---
>>>   po/README | 22 ++++++++++++++++++++++
>>>   1 file changed, 22 insertions(+)
>>>
>>> diff --git a/po/README b/po/README
>>> index efd5baaf1d..9beffc2954 100644
>>> --- a/po/README
>>> +++ b/po/README
>>> @@ -286,3 +286,25 @@ Testing marked strings
>>>
>>>   Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
>>>   changed to account for translations as they're added.
>>> +
>>> +
>>> +PO Helper
>>> +---------
>>> +
>>> +To make maintaining XX.po file easier, the l10n coordinator created
>>> +po-helper.sh script. It is wrapper to gettext suite, specifically
>>
>> It's better to rename the script to other name without the suffix
>> ".sh", so we can reimplement it in other programming language. Maybe
>> we can rename it to `git-po-helper`, and host this helper in a
>> separate project on GitHub.
> 
> It might be a good move in the longer term, but if the po-helper.sh
> is working well enough to fill the need of i18n/l10n team right now,
> I think documenting the status quo would be a good way to help the
> contributors immediately.
> 
> And when we reimplement it (if that is desirable---I have no opinion
> myself), we certainly would want to update this part of the doc to
> use the name of the rewritten tool.
> 
> In any case, I expect that you to be the main reviewer on this topic
> and you will feed me the final commits, just like any other change
> in the po/* area via a pull request.  In other words, I may have
> input to the discussion on list, but I won't be applying the result
> myself---I'll be pulling from git://github.com/git-l10n/git-po.git
> repository instead.
> 
> Thanks.
> 

Grazie Junio. However, I'm more of writing documentation rather than
contributing code, so I will help for the documentation and usage
testing. But anyways, we can ask for help from other l10n contributors
who are more proficient at coding.
Jiang Xin May 13, 2021, 3:40 p.m. UTC | #4
Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月12日周五 下午7:57写道:
>
>
> On 12/03/21 13.03, Junio C Hamano wrote:
> > Jiang Xin <worldhello.net@gmail.com> writes:
> >
> >> Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道:
> >>>
> >>> Document about PO helper script (po-helper.sh). It covers about
> >>> installing the script and short usage examples.
> >>>
> >>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> >>> ---
> >>>   po/README | 22 ++++++++++++++++++++++
> >>>   1 file changed, 22 insertions(+)
> >>>
> >>> diff --git a/po/README b/po/README
> >>> index efd5baaf1d..9beffc2954 100644
> >>> --- a/po/README
> >>> +++ b/po/README
> >>> @@ -286,3 +286,25 @@ Testing marked strings
> >>>
> >>>   Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
> >>>   changed to account for translations as they're added.
> >>> +
> >>> +
> >>> +PO Helper
> >>> +---------
> >>> +
> >>> +To make maintaining XX.po file easier, the l10n coordinator created
> >>> +po-helper.sh script. It is wrapper to gettext suite, specifically
> >>
> >> It's better to rename the script to other name without the suffix
> >> ".sh", so we can reimplement it in other programming language. Maybe
> >> we can rename it to `git-po-helper`, and host this helper in a
> >> separate project on GitHub.
> >
> > It might be a good move in the longer term, but if the po-helper.sh
> > is working well enough to fill the need of i18n/l10n team right now,
> > I think documenting the status quo would be a good way to help the
> > contributors immediately.
> >
> > And when we reimplement it (if that is desirable---I have no opinion
> > myself), we certainly would want to update this part of the doc to
> > use the name of the rewritten tool.
> >
> > In any case, I expect that you to be the main reviewer on this topic
> > and you will feed me the final commits, just like any other change
> > in the po/* area via a pull request.  In other words, I may have
> > input to the discussion on list, but I won't be applying the result
> > myself---I'll be pulling from git://github.com/git-l10n/git-po.git
> > repository instead.
> >
> > Thanks.
> >
>
> Grazie Junio. However, I'm more of writing documentation rather than
> contributing code, so I will help for the documentation and usage
> testing. But anyways, we can ask for help from other l10n contributors
> who are more proficient at coding.
>
Hi Bagas,

I created a new repository at
https://github.com/git-l10n/git-po-helper that contains a new helper
program `git-po-helper` to replace the obsolete `po-helper.sh` script.

The new `git-po-helper` program can check character encoding of the
commit log, check author/committer datetime, and check format of
`po/TEAMS`, etc., in addition to the conventions listed in README of
the new project "git-l10n/git-po-helper".

You can update your patches according to this change.

All l10n contributors can use this new helper to check their l10n contributions.

BTW, with the help of Daniel, a google group named git-l10n is created
for discussion on git-l10n. This mail is also cc to this email
address: git-l10n@googlegroups.com .

--
Jiang Xin
Jiang Xin May 27, 2021, 3:11 a.m. UTC | #5
Jiang Xin <worldhello.net@gmail.com> 于2021年5月13日周四 下午11:40写道:
>
> Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月12日周五 下午7:57写道:
> >
> >
> > On 12/03/21 13.03, Junio C Hamano wrote:
> > > Jiang Xin <worldhello.net@gmail.com> writes:
> > >
> > >> Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道:
> > >>>
> > >>> Document about PO helper script (po-helper.sh). It covers about
> > >>> installing the script and short usage examples.
> > >>>
> > >>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> > >>> ---
> > >>>   po/README | 22 ++++++++++++++++++++++
> > >>>   1 file changed, 22 insertions(+)
> > >>>
> > >>> diff --git a/po/README b/po/README
> > >>> index efd5baaf1d..9beffc2954 100644
> > >>> --- a/po/README
> > >>> +++ b/po/README
> > >>> @@ -286,3 +286,25 @@ Testing marked strings
> > >>>
> > >>>   Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
> > >>>   changed to account for translations as they're added.
> > >>> +
> > >>> +
> > >>> +PO Helper
> > >>> +---------
> > >>> +
> > >>> +To make maintaining XX.po file easier, the l10n coordinator created
> > >>> +po-helper.sh script. It is wrapper to gettext suite, specifically
> > >>
> > >> It's better to rename the script to other name without the suffix
> > >> ".sh", so we can reimplement it in other programming language. Maybe
> > >> we can rename it to `git-po-helper`, and host this helper in a
> > >> separate project on GitHub.
> > >
> > > It might be a good move in the longer term, but if the po-helper.sh
> > > is working well enough to fill the need of i18n/l10n team right now,
> > > I think documenting the status quo would be a good way to help the
> > > contributors immediately.
> > >
> > > And when we reimplement it (if that is desirable---I have no opinion
> > > myself), we certainly would want to update this part of the doc to
> > > use the name of the rewritten tool.
> > >
> > > In any case, I expect that you to be the main reviewer on this topic
> > > and you will feed me the final commits, just like any other change
> > > in the po/* area via a pull request.  In other words, I may have
> > > input to the discussion on list, but I won't be applying the result
> > > myself---I'll be pulling from git://github.com/git-l10n/git-po.git
> > > repository instead.
> > >
> > > Thanks.
> > >
> >
> > Grazie Junio. However, I'm more of writing documentation rather than
> > contributing code, so I will help for the documentation and usage
> > testing. But anyways, we can ask for help from other l10n contributors
> > who are more proficient at coding.
> >
> Hi Bagas,
>
> I created a new repository at
> https://github.com/git-l10n/git-po-helper that contains a new helper
> program `git-po-helper` to replace the obsolete `po-helper.sh` script.
>
> The new `git-po-helper` program can check character encoding of the
> commit log, check author/committer datetime, and check format of
> `po/TEAMS`, etc., in addition to the conventions listed in README of
> the new project "git-l10n/git-po-helper".
>
> You can update your patches according to this change.
>
> All l10n contributors can use this new helper to check their l10n contributions.
>
> BTW, with the help of Daniel, a google group named git-l10n is created
> for discussion on git-l10n. This mail is also cc to this email
> address: git-l10n@googlegroups.com .

Based on pull request form Bagas, that made some nice changes for
"po/README", I recreated a new pull request #525 on GitHub:

    https://github.com/git-l10n/git-po/pull/525

Please help to review.  This pull request contains the following commits:

 + 826abe532f l10n: README: note on fuzzy translations
 + 93f2050952 l10n: README: document l10n conventions
 + 1466dc3b86 l10n: README: document "core translation"
 + 06d662e594 l10n: README: document git-po-helper
 + a5724c83a2 l10n: README: add file extention ".md"

You can download the commits using command:

    git fetch https://github.com/git-l10n/git-po refs/pull/525/head

--
Jiang Xin
diff mbox series

Patch

diff --git a/po/README b/po/README
index efd5baaf1d..9beffc2954 100644
--- a/po/README
+++ b/po/README
@@ -286,3 +286,25 @@  Testing marked strings
 
 Git's tests are run under LANG=C LC_ALL=C. So the tests do not need be
 changed to account for translations as they're added.
+
+
+PO Helper
+---------
+
+To make maintaining XX.po file easier, the l10n coordinator created
+po-helper.sh script. It is wrapper to gettext suite, specifically
+written for the purpose of Git l10n workflow.
+
+To install the script, checkout "po-helper" branch, then copy
+utils/po-helper.sh to somewhere on $PATH, and mark it executable.
+
+Below are the usage examples:
+
+  - To start new language translation:
+        po-helper.sh init XX.po
+  - To update PO file:
+        po-helper.sh update XX.po
+  - To syntax check:
+        po-helper.sh check XX.po
+
+Run po-helper.sh without arguments for usage help.