[PATCH] docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4

[PATCH] docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4

[Akira Yokosawa]

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
     \newcommand{\kerneldocCJKon}{\makexeCJKactive\onehalfspacing}

base-commit: fe2562582bffe675721e77e00b3bf5bfa1d7aeab
-- 
2.34.1

Re: [PATCH] docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4

[Jonathan Corbet]

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