[PATCH] docs: cdrom: Fix a typo and rst markup

[PATCH] docs: cdrom: Fix a typo and rst markup

[Remi Andruccioli]

"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@gmail.com>
---
 Documentation/cdrom/cdrom-standard.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/cdrom/cdrom-standard.rst b/Documentation/cdrom/cdrom-standard.rst
index 2de905810590..70500b189cc8 100644
--- a/Documentation/cdrom/cdrom-standard.rst
+++ b/Documentation/cdrom/cdrom-standard.rst
@@ -557,7 +557,7 @@ phase. Currently, the capabilities are any of::
 	CDC_DRIVE_STATUS	/* driver implements drive status */
 
 The capability flag is declared *const*, to prevent drivers from
-accidentally tampering with the contents. The capability fags actually
+accidentally tampering with the contents. The capability flags actually
 inform `cdrom.c` of what the driver can do. If the drive found
 by the driver does not have the capability, is can be masked out by
 the *cdrom_device_info* variable *mask*. For instance, the SCSI CD-ROM
@@ -736,7 +736,7 @@ Description of routines in `cdrom.c`
 
 Only a few routines in `cdrom.c` are exported to the drivers. In this
 new section we will discuss these, as well as the functions that `take
-over' the CD-ROM interface to the kernel. The header file belonging
+over` the CD-ROM interface to the kernel. The header file belonging
 to `cdrom.c` is called `cdrom.h`. Formerly, some of the contents of this
 file were placed in the file `ucdrom.h`, but this file has now been
 merged back into `cdrom.h`.
-- 
2.26.2

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

[Jonathan Corbet]

On Sat,  8 Aug 2020 18:31:23 +0200
Remi Andruccioli <remi.andruccioli@gmail.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@gmail.com>
> ---
>  Documentation/cdrom/cdrom-standard.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

I've applied this, thanks.

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.

jon

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

[Remi Andruccioli]

On Tue, 11 Aug 2020 18:44:32 +0200, Jonathan Corbet <corbet@lwn.net> wrote:
> On Sat,  8 Aug 2020 18:31:23 +0200
> Remi Andruccioli <remi.andruccioli@gmail.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@gmail.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