public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Vishal Singh <vishalrajput96156@gmail.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Vishal Singh <vishalrajput96156@gmail.com>,
	Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: [PATCH] docs: conf.py: drop stale FIXME about pdf index size
Date: Wed, 07 Jan 2026 11:09:40 +0200	[thread overview]
Message-ID: <235ee0bbf3f6cfc3868b818d09de9185e1c1cb50@intel.com> (raw)
In-Reply-To: <87eco2csd0.fsf@trenco.lwn.net>

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

      reply	other threads:[~2026-01-07  9:09 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-23 12:15 [PATCH] docs: conf.py: drop stale FIXME about pdf index size Vishal Singh
2026-01-06 22:02 ` Jonathan Corbet
2026-01-07  9:09   ` Jani Nikula [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=235ee0bbf3f6cfc3868b818d09de9185e1c1cb50@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=vishalrajput96156@gmail.com \
    /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