linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: corbet@lwn.net, vegard.nossum@oracle.com, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: freeze some package versions for sphinx virtualenv setup
Date: Tue, 27 Feb 2024 09:24:10 +0100	[thread overview]
Message-ID: <CAKXUXMz1HLYKo=D4UrtPDf3GO4VjxXmU1xtYm_aZ3tXo6PrekQ@mail.gmail.com> (raw)
In-Reply-To: <a6e683f5-3088-48ef-9930-93c95e85c5ce@gmail.com>

On Tue, Feb 27, 2024 at 7:57 AM Akira Yokosawa <akiyks@gmail.com> wrote:
>
> [dropping most CCs]
>
> Hello Lukas,
>
> This is a friendly notice for filling in some contexts.
>
> On Mon, 26 Feb 2024 10:38:54 +0100, Lukas Bulwahn wrote:
> [...]
> > Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
> > was fast in providing a fix (see Link). This however remained as a thread
> > on the linux-doc mailing and was never turned into a patch for Jonathan to
> > pick up.
>
> Have you read Jon's message in the thread archived at:
>
>     https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/
>
> I think you can see why there had been no submission of a proper patch
> in your patch's direction nor others.
>
> If you still want your patch applied soon, you need to convince Jon.
>
> A patch that helps us to go in the direction of 1) in Jon's message is
> most welcome!
>
> Be aware that if you simply remove ==2.4.4 from requirements.txt,
> sphinx-pre-install will prevent you from running "make htmldocs".
>
> You'll see this error:
>
>     Can't get default sphinx version from ./Documentation/sphinx/requirements.txt at ./scripts/sphinx-pre-install line 305.
>

Yes, I have seen Jonathan's message. I also read that updating to
recent versions---despite the slight performance issues---is the way
forward. I will try out if I can make a proper patch to get that setup
working.

However, I also read:
Jonathan is "happy to not break 2.4.4 for now, though I suspect that
day may come". Hence, as the current sphinx 2.4.4 setup is broken and
still the one and only way that is documented on how to set up the
kernel documentation build, I thought we will need to at least get
that back into the working state until the documentation for how to
use the new versions is in place.

Hence, I proposed this patch here. It works (for me). But I do not
care if it is picked or not---because I am just continuing the
whack-a-mole game. As of now, I do not know how much work the better
solution for "updating to recent versions" needs. I will spend half a
day and hopefully I can then present a good working patch. But let us
see.


Lukas

  reply	other threads:[~2024-02-27  8:24 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-26  9:38 [PATCH] docs: freeze some package versions for sphinx virtualenv setup Lukas Bulwahn
2024-02-27  6:56 ` Akira Yokosawa
2024-02-27  8:24   ` Lukas Bulwahn [this message]
2024-02-27  8:40     ` Vegard Nossum
2024-02-27 13:17       ` Lukas Bulwahn

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='CAKXUXMz1HLYKo=D4UrtPDf3GO4VjxXmU1xtYm_aZ3tXo6PrekQ@mail.gmail.com' \
    --to=lukas.bulwahn@gmail.com \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=vegard.nossum@oracle.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;
as well as URLs for NNTP newsgroup(s).