linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-kernel@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH 0/6] Some improvements for the doc build system
Date: Sun, 22 Jun 2025 06:00:15 +0200	[thread overview]
Message-ID: <20250622060015.76a0b29a@foz.lan> (raw)
In-Reply-To: <87ldpkdgv6.fsf@trenco.lwn.net>

Em Sat, 21 Jun 2025 13:39:09 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > Hi Jon,
> >
> > This series contain some patches from my parser-yaml one that
> > aren't directly related to it. It basically addresses some issues
> > at the build system. It also adds a script that I wrote with the
> > purpose of checking backward problems when building against
> > older toolchains.
> >
> > IMO, the best is to merge and apply it before the YAML series.  
> 
> OK, I've applied it, but ... someday, I think the test_doc_build tool
> should be properly documented and put somewhere under tools/testing.

I added a better documentation for the tool at the v2.

With regards to move to tools, I'm not certain about it as I can see
advantages and disadvantages. 

Creating a new directory to have just one tool on it seems overkill
to me. Also, it is easier to type "scripts/..." than 
"tools/testing/build/..." :-)

There is another aspect: while doing conf.py and Documentation/Makefile
cleanup, I noticed that there are still lots of hacks inside them,
that are there from the early days when we adopted Sphinx. Perhaps
it could make sense to move part of the logic there to this new
build tool, which could, for instance, replace the logic inside
scripts/sphinx-pre-install and get rid of some magic at the Makefile
like the one which handles SPHINXDIRS.

So, at least for now, I would prefer to keep it under scripts.

Thanks,
Mauro

  reply	other threads:[~2025-06-22  4:00 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-20  8:11 [PATCH 0/6] Some improvements for the doc build system Mauro Carvalho Chehab
2025-06-20  8:11 ` [PATCH 1/6] docs: conf.py: properly handle include and exclude patterns Mauro Carvalho Chehab
2025-06-20  8:11 ` [PATCH 2/6] docs: Makefile: disable check rules on make cleandocs Mauro Carvalho Chehab
2025-06-20  8:11 ` [PATCH 3/6] scripts: scripts/test_doc_build.py: add script to test doc build Mauro Carvalho Chehab
2025-06-20  8:11 ` [PATCH 4/6] scripts/test_doc_build.py: make capture assynchronous Mauro Carvalho Chehab
2025-06-20  8:11 ` [PATCH 5/6] scripts: test_doc_build.py: better control its output Mauro Carvalho Chehab
2025-06-20  8:11 ` [PATCH 6/6] docs: sphinx: add a file with the requirements for lowest version Mauro Carvalho Chehab
2025-06-21 19:39 ` [PATCH 0/6] Some improvements for the doc build system Jonathan Corbet
2025-06-22  4:00   ` Mauro Carvalho Chehab [this message]
2025-06-22 18:44     ` Jonathan Corbet
2025-06-22 19:44       ` Mauro Carvalho Chehab

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=20250622060015.76a0b29a@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@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).