[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <87o76f98lr.fsf@trenco.lwn.net>
Date: Mon, 29 Jul 2024 15:44:16 -0600
From: Jonathan Corbet <corbet@....net>
To: Dongliang Mu <dzm91@...t.edu.cn>, chengziqiu@...t.edu.cn, Alex Shi
<alexs@...nel.org>, Yanteng Si <siyanteng@...ngson.cn>, Dongliang Mu
<dzm91@...t.edu.cn>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 2/2] doc-guide: add help documentation
checktransupdate.rst
For future reference, a sequence like this:
> +Then the output is something like:
> +
> +::
> +
> + Documentation/dev-tools/kfence.rst
Can be more concisely and legibly expressed as:
> Then the output is something like::
>
> (literal text here)
More importantly, though, this file:
> diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
> new file mode 100644
> index 000000000000..dabbf9ecd187
> --- /dev/null
> +++ b/Documentation/doc-guide/checktransupdate.rst
> @@ -0,0 +1,53 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +Check translation update
> +
> +This script helps track the translation status of the documentation in
> +different locales, i.e., whether the documentation is up-to-date with
> +the English counterpart.
...lacks a title, so it renders strangely and inserts inscrutable stuff
into the doc-guide index. I have fixed this, but I am not entirely
happy about that; this is a problem you should have seen immediately by
looking at the rendered version of your new document. *Please* be a bit
more careful in the future.
Both patches applied, anyway.
jon
Powered by blists - more mailing lists