linux-kernel - Re: [PATCH] docs: cdrom: Fix a typo and rst markup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Thu, 13 Aug 2020 00:13:33 +0200
From:   Remi Andruccioli <remi.andruccioli@...il.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Jens Axboe <axboe@...nel.dk>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: cdrom: Fix a typo and rst markup



On Tue, 11 Aug 2020 18:44:32 +0200, Jonathan Corbet <corbet@....net> wrote:
> On Sat,  8 Aug 2020 18:31:23 +0200
> Remi Andruccioli <remi.andruccioli@...il.com> wrote:
> 
>> "The capability fags" should be "The capability flags".
>>
>> In rst markup, a incorrect markup expression is causing bad rendering in
>> Sphinx output. Replace the erroneous single quote by a backquote.
>>
>> Signed-off-by: Remi Andruccioli <remi.andruccioli@...il.com>
>> ---
>>  Documentation/cdrom/cdrom-standard.rst | 4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> I've applied this, thanks.
Thanks to you Jonathan.
> 
> The backtick replacement makes the warning go away, but a better fix would
> be to remove the backticks entirely; I'm not sure why they are used as
> quotes in that file.
Yes, I agree with you. Actually I did it that way to stay consistent with the
rest of the file although I noticed something was wrong with the rst markup.

After investigating today, this file comes from an old LaTeX file that later
was converted to rst with some tool. That tool replaced different LaTeX
commands from the original tex file by backticks (minus the one from my fix).
After recovering the original tex file and compiling it I could figure out
what was wrong and see the original intention of the authors in the LaTeX
compiled result: some words/expressions appear 'quoted' while filenames are
rendered in a mono font.
So even the current Sphinx output is wrong since the conversion of this
file, as everything gets currently rendered in italics.

Last version of the tex file can be recovered at:
b693d0b372afb39432e1c49ad7b3454855bc6bed

Conversion to rst was done in:
e327cfcb25422c91f4bb8e8a3488386ac95955f1

I'll see what I can do to replace all those backticks by the proper rst
markup according to the original tex file.
> 
> jon
> 
Yours,

Remi Andruccioli