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

From: Jiang Xin <worldhello.net@gmail.com>
Date: Mar 12, 2021, 01:32 UTC
Message-ID: <CANYiYbH_U=3gN+LH7e-LBdRdcE0geAuUzoBX4O09qego0xKX-Q@mail.gmail.com>
In-Reply-To: <20210311125511.51152-2-bagasdotme@gmail.com>

Bagas Sanjaya <bagasdotme@gmail.com> 于2021年3月11日周四 下午8:56写道：

Show 24 quoted lines

>
> 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.

Show 18 quoted lines

> +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
>