linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: linux-doc@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH] docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4
Date: Sun, 03 Mar 2024 08:15:49 -0700	[thread overview]
Message-ID: <87o7bvz6qi.fsf@meer.lwn.net> (raw)
In-Reply-To: <ed1ec6f2-0050-46f6-807d-8679f26427e9@gmail.com>

Akira Yokosawa <akiyks@gmail.com> writes:

> Now that Sphinx 2.4.4 or better is required, get rid of
> \providecommand{}'s for compatibility with Sphinx 1.7.9.
>
> While at it, reword the comment on \sphinxtableofcontentshook
> for better description of why it needs to be emptied.
>
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> ---
>  Documentation/sphinx/kerneldoc-preamble.sty | 7 +------
>  1 file changed, 1 insertion(+), 6 deletions(-)
>
> diff --git a/Documentation/sphinx/kerneldoc-preamble.sty b/Documentation/sphinx/kerneldoc-preamble.sty
> index 9707e033c8c4..3092df051c95 100644
> --- a/Documentation/sphinx/kerneldoc-preamble.sty
> +++ b/Documentation/sphinx/kerneldoc-preamble.sty
> @@ -54,9 +54,7 @@
>  \renewcommand*\l@section{\@dottedtocline{1}{2.4em}{3.2em}}
>  \renewcommand*\l@subsection{\@dottedtocline{2}{5.6em}{4.3em}}
>  \makeatother
> -%% Sphinx < 1.8 doesn't have \sphinxtableofcontentshook
> -\providecommand{\sphinxtableofcontentshook}{}
> -%% Undefine it for compatibility with Sphinx 1.7.9
> +%% Prevent default \sphinxtableofcontentshook from overwriting above tweaks.
>  \renewcommand{\sphinxtableofcontentshook}{} % Empty the hook
>  
>  % Prevent column squeezing of tabulary.  \tymin is set by Sphinx as:
> @@ -136,9 +134,6 @@
>      }
>      \newCJKfontfamily[JPsans]\jpsans{Noto Sans CJK JP}[AutoFakeSlant]
>      \newCJKfontfamily[JPmono]\jpmono{Noto Sans Mono CJK JP}[AutoFakeSlant]
> -    % Dummy commands for Sphinx < 2.3 (no 'extrapackages' support)
> -    \providecommand{\onehalfspacing}{}
> -    \providecommand{\singlespacing}{}
>      % Define custom macros to on/off CJK
>      %% One and half spacing for CJK contents

Applied, thanks.

jon

      reply	other threads:[~2024-03-03 15:15 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-01 14:41 [PATCH] docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4 Akira Yokosawa
2024-03-03 15:15 ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87o7bvz6qi.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=akiyks@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).