[PATCH] docs: conf.py: drop stale FIXME about pdf index size

[PATCH] docs: conf.py: drop stale FIXME about pdf index size

[Vishal Singh]

The comment describes intentional behavior and does not indicate
unfinished work. Remove the FIXME marker and keep it as a normal
explanatory comment.

Signed-off-by: Vishal Singh <vishalrajput96156@gmail.com>
---
 Documentation/conf.py | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 1ea2ae5c6276..7e0817469e86 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -572,9 +572,8 @@ epub_exclude_files = ["search.html"]
 #
 # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
 #
-# FIXME: Do not add the index file here; the result will be too big. Adding
-# multiple PDF files here actually tries to get the cross-referencing right
-# *between* PDF files.
+# Do not add the index file here; the result would be too big. Adding multiple
+# PDF files here tries to keep cross-referencing correct *between* PDF files.
 pdf_documents = [
     ("kernel-documentation", "Kernel", "Kernel", "J. Random Bozo"),
 ]
-- 
2.34.1

Re: [PATCH] docs: conf.py: drop stale FIXME about pdf index size

[Jonathan Corbet]

Vishal Singh <vishalrajput96156@gmail.com> writes:

CC += Jani

> The comment describes intentional behavior and does not indicate
> unfinished work. Remove the FIXME marker and keep it as a normal
> explanatory comment.
>
> Signed-off-by: Vishal Singh <vishalrajput96156@gmail.com>
> ---
>  Documentation/conf.py | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 1ea2ae5c6276..7e0817469e86 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -572,9 +572,8 @@ epub_exclude_files = ["search.html"]
>  #
>  # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
>  #
> -# FIXME: Do not add the index file here; the result will be too big. Adding
> -# multiple PDF files here actually tries to get the cross-referencing right
> -# *between* PDF files.
> +# Do not add the index file here; the result would be too big. Adding multiple
> +# PDF files here tries to keep cross-referencing correct *between* PDF files.

I think the comment doesn't have much to tell people either way, I
wonder if it can just go altogether.  Jani, what problem is actually
being described here?

Thanks,

jon

Re: [PATCH] docs: conf.py: drop stale FIXME about pdf index size

[Jani Nikula]

On Tue, 06 Jan 2026, Jonathan Corbet <corbet@lwn.net> wrote:
> Vishal Singh <vishalrajput96156@gmail.com> writes:
>
> CC += Jani
>
>> The comment describes intentional behavior and does not indicate
>> unfinished work. Remove the FIXME marker and keep it as a normal
>> explanatory comment.
>>
>> Signed-off-by: Vishal Singh <vishalrajput96156@gmail.com>
>> ---
>>  Documentation/conf.py | 5 ++---
>>  1 file changed, 2 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/conf.py b/Documentation/conf.py
>> index 1ea2ae5c6276..7e0817469e86 100644
>> --- a/Documentation/conf.py
>> +++ b/Documentation/conf.py
>> @@ -572,9 +572,8 @@ epub_exclude_files = ["search.html"]
>>  #
>>  # See the Sphinx chapter of https://ralsina.me/static/manual.pdf
>>  #
>> -# FIXME: Do not add the index file here; the result will be too big. Adding
>> -# multiple PDF files here actually tries to get the cross-referencing right
>> -# *between* PDF files.
>> +# Do not add the index file here; the result would be too big. Adding multiple
>> +# PDF files here tries to keep cross-referencing correct *between* PDF files.
>
> I think the comment doesn't have much to tell people either way, I
> wonder if it can just go altogether.  Jani, what problem is actually
> being described here?

I think it's related to some early experiments with rst2pdf for Sphinx
PDF output. But I don't think anyone uses that. I think the whole
pdf_documents configuration and the comment above it could be removed.

Cc: Mauro.


BR,
Jani.


-- 
Jani Nikula, Intel