On Tue, Jul 30, 2024 at 5:44 AM Jonathan Corbet <corbet@xxxxxxx> wrote: > > 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) > Hi jon, If I understand correctly, you mean to remove "::", right? If yes, the rendered version looks very strange, e.g, the document - Documentation/dev-tools/kfence.rst will be rendered as a file. > 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 >
