Re: [PATCH 1/1] docs: fix kernel-driver-statement rendering

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon,  5 Oct 2020 15:02:13 +0200
Gaëtan Harter <hartergaetan@xxxxxxxxx> wrote:

> Remove the extra newline and indentation after `J. Bruce Fields` in the
> rendered html, and extra indentation in the rendered pdf.
> 
> The `J.` sequence was interpreted by sphinx as a letter ordered list
> starting at letter `J`.  It produced a sub ordered list as item of the
> main item list.
> 
>     <li><ol class="first upperalpha" start="10">
>     <li>Bruce Fields</li>
>     </ol>
>     </li>
> 
> The escaping is done before the name and not between the `J` and `.` to
> keep the name writing intact.
> 
> Signed-off-by: Gaëtan Harter <hartergaetan@xxxxxxxxx>
> ---
>  Documentation/process/kernel-driver-statement.rst               | 2 +-
>  .../translations/it_IT/process/kernel-driver-statement.rst      | 2 +-
>  .../translations/zh_CN/process/kernel-driver-statement.rst      | 2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/process/kernel-driver-statement.rst b/Documentation/process/kernel-driver-statement.rst
> index a849790a68bc..3a89fec1882e 100644
> --- a/Documentation/process/kernel-driver-statement.rst
> +++ b/Documentation/process/kernel-driver-statement.rst
> @@ -67,7 +67,7 @@ today, have in the past, or will in the future.
>   - Pekka Enberg
>   - Jan Engelhardt
>   - Mark Fasheh
> - - J. Bruce Fields
> + - \ J. Bruce Fields
>   - Larry Finger

Thanks for figuring this out and explaining it so well.  This is a sad
ambiguity in the RST syntax, I guess.

In this case, though, I'm not convinced that the cure isn't worse than the
disease.  We've traded a blank line in the HTML output for some ugly
markup in the original text; I'm not sure we want to do that.

For this particular file, perhaps the best solution is just to put the
list of signatures into a literal block.  The fix for other occurrences
may be different.

Thanks,

jon



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux