Re: [PATCH] docs: Instruct LaTeX to cope with deeper nesting

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

 



On Mon, 19 Feb 2024 09:05:38 -0700, Jonathan Corbet wrote:
> The addition of the XFS online fsck documentation starting with
> commit a8f6c2e54ddc ("xfs: document the motivation for online fsck design")
> added a deeper level of nesting than LaTeX is prepared to deal with.  That
> caused a pdfdocs build failure with the helpful "Too deeply nested" error
> message buried deeply in Documentation/output/filesystems.log.
> 
> Increase the "maxlistdepth" parameter to instruct LaTeX that it needs to
> deal with the deeper nesting whether it wants to or not.
> 
> Suggested-by: Akira Yokosawa <akiyks@xxxxxxxxx>
> Link: https://lore.kernel.org/linux-doc/67f6ac60-7957-4b92-9d72-a08fbad0e028@xxxxxxxxx/
> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>

Tested-by: Akira Yokosawa <akiyks@xxxxxxxxx>

And it seems this one might deserve

Cc: stable@xxxxxxxxxxxxxxx # v6.4

too, in case someone tries "make pdfdocs" against 6.6.x LTS 
and 6.7.x stable branches.

Commit a8f6c2e54ddc did nothing wrong on its own, so a Fixes: tag
is inappropriate here.

> ---
>  Documentation/conf.py | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 5830b01c5642..da64c9fb7e07 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -388,6 +388,12 @@ latex_elements = {
>          verbatimhintsturnover=false,
>      ''',
>  
> +    #
> +    # Some of our authors are fond of deep nesting; tell latex to
> +    # cope.

I like this wording! :-)

        Thanks, Akira

> +    #
> +    'maxlistdepth': '10',
> +
>      # For CJK One-half spacing, need to be in front of hyperref
>      'extrapackages': r'\usepackage{setspace}',
>





[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