From: Jonathan Corbet <corbet@lwn.net>
To: Dongliang Mu <dzm91@hust.edu.cn>,
chengziqiu@hust.edu.cn, Alex Shi <alexs@kernel.org>,
Yanteng Si <siyanteng@loongson.cn>,
Dongliang Mu <dzm91@hust.edu.cn>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst
Date: Mon, 29 Jul 2024 15:44:16 -0600 [thread overview]
Message-ID: <87o76f98lr.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20240719041400.3909775-3-dzm91@hust.edu.cn>
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
next prev parent reply other threads:[~2024-07-29 21:44 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20240719041400.3909775-1-dzm91@hust.edu.cn>
2024-07-19 4:13 ` [PATCH v3 1/2] scripts: fix all issues reported by pylint Dongliang Mu
2024-07-19 9:08 ` Yanteng Si
2024-07-19 4:13 ` [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst Dongliang Mu
2024-07-19 9:08 ` Yanteng Si
2024-07-29 21:44 ` Jonathan Corbet [this message]
2024-07-30 3:43 ` Dongliang Mu
2024-07-30 13:39 ` Jonathan Corbet
2024-07-31 7:18 ` Dongliang Mu
2024-07-31 13:01 ` Jonathan Corbet
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=87o76f98lr.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=alexs@kernel.org \
--cc=chengziqiu@hust.edu.cn \
--cc=dzm91@hust.edu.cn \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=siyanteng@loongson.cn \
/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