Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Sat, 17 Apr 2021 10:47:02 +0800
From:   "Wu X.C." <bobwxc@email.cn>
To:     Jonathan Corbet <corbet@lwn.net>
Cc:     Alex Shi <alexs@kernel.org>,
        Federico Vaga <federico.vaga@vaga.pv.it>,
        Masahiro Yamada <masahiroy@kernel.org>,
        Tsugikazu Shibata <tshibata@ab.jp.nec.com>,
        SeongJae Park <sjpark@amazon.de>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [RFC 0/2] Add a new translation tool scripts/trslt.py
Message-ID: <20210417024702.GA21292@bobwxc.top>
References: <cover.1618208899.git.bobwxc@email.cn>
 <871rbbi7pn.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="0F1p//8PRICkK4MW"
Content-Disposition: inline
In-Reply-To: <871rbbi7pn.fsf@meer.lwn.net>
User-Agent: Mutt/1.10.1 (2018-07-13)
Precedence: bulk


--0F1p//8PRICkK4MW
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, Apr 15, 2021 at 03:00:36PM -0600, Jonathan Corbet wrote:
> Wu XiangCheng <bobwxc@email.cn> writes:
>=20
> > Hi all,
> >
> > This set of patches aim to add a new translation tool - trslt.py, which
> > can control the transltions version corresponding to source files.
> >
> > For a long time, kernel documentation translations lacks a way to contr=
ol the
> > version corresponding to the source files. If you translate a file and =
then
> > someone updates the source file, there will be a problem. It's hard to =
know
> > which version the existing translation corresponds to, and even harder =
to sync
> > them.=20
> >
> > The common way now is to check the date, but this is not exactly accura=
te,
> > especially for documents that are often updated. And some translators w=
rite=20
> > corresponding commit ID in the commit log for reference, it is a good w=
ay,=20
> > but still a little troublesome.
> >
> > Thus, the purpose of ``trslt.py`` is to add a new annotating tag to the=
 file
> > to indicate corresponding version of the source file::
> >
> > .. translation_origin_commit: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
> >
> > The script will automatically copy file and generate tag when creating =
new
> > translation, and give update suggestions based on those tags when updat=
ing
> > translations.
> >
> > More details please read doc in [Patch 2/2].
>=20
> So, like Federico, I'm unconvinced about putting this into the
> translated text itself.  This is metadata, and I'd put it with the rest
> of the metadata.  My own suggestion would be a tag like:
>=20
>   Translates: 6161a4b18a66 ("docs: reporting-issues: make people CC the r=
egressions list")
>=20
> It would be an analogue to the Fixes tag in this regard; you could have
> more than one of them if need be.

Yes, that's also a good idea rather than add a tag to text itself.

>=20
> I'm not sure we really need a script in the kernel tree for this; it
> seems like what you really want is some sort of git commit hook.  That
> said, if you come up with something useful, we can certainly find a
> place for it.

Emmm, thought again.

Maybe we just need a doc to tell people recommended practice, just put a
script or hook in the doc.

Use it or not, depend on themselves. That's may easier, but I'm worried
about whether this loose approach will work better.

Thanks!

Wu X.C.

--0F1p//8PRICkK4MW
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQGzBAABCgAdFiEERbo3U5kJpaCtFl1PtlsoEiKCsIUFAmB6TCIACgkQtlsoEiKC
sIV0DQwAs6kC2TRcIs+42F2bspvSpcjeU3W05y/wwZPppem7GMUw5tyqs9kG/Qhm
mnSbfiPzI6OqhZcYmuXKkZ6kZdRFc92QOlm17kiuhJd6dIanj3+6AfqSGHVmYyNJ
H2VKs+nBvDDkYGtt/sF2iyee0jTnBRZ4d9bkP9nmfVqg7EMv1v/q17crfSaiEZ0A
S8XndocCCRt2QaIMLJNWc+Zz3V0TYxo3xexJfQfnLIRlIiqkf0+tVBGEixTh4TJ2
RXY2upHv+Em01alhDBpQw70hwKjMMRdboDlo9dK6GGNTeF/2Dn3HSXC2nvkBl3U6
e2RFR9496z5cs7ilBSxGHjw0lTeNjmI7JFcIrVEFn/zagDK8seyOsjkX65XRO80W
xtNqIHmVQTKzTwkYFMmqGhp5qPx6i8oyeQwMNunSwEY4v6xEOo/ykinbE7TiQQNp
3GyizNMD1QImMLG/P4AbwKlafqsuLJh2+hIWAySOgVKon6nUfMkac/zYRnLbVf+Y
rFTxKRaa
=4rpE
-----END PGP SIGNATURE-----

--0F1p//8PRICkK4MW--