[PATCH v2 0/2] Some extra patches for netlink doc generation

Mauro Carvalho Chehab posted 2 patches 4 months ago
Documentation/conf.py                         | 7 +++++--
Documentation/userspace-api/netlink/index.rst | 2 +-
Documentation/userspace-api/netlink/specs.rst | 2 +-
3 files changed, 7 insertions(+), 4 deletions(-)
[PATCH v2 0/2] Some extra patches for netlink doc generation
Posted by Mauro Carvalho Chehab 4 months ago
This patch series comes after:
	https://lore.kernel.org/linux-doc/cover.1749723671.git.mchehab+huawei@kernel.org/T/#t	
The first patch is meant to speedup glob time by not adding all yaml to the parser.

The second one adjusts the location of netlink/specs/index.rst.

With that, on my AMD Ryzen 9 7900 machine, the time to do a full build after a
cleanup is:

real    7m29,196s
user    14m21,893s
sys     2m28,510s

Mauro Carvalho Chehab (2):
  docs: conf.py: add include_pattern to speedup
  docs: uapi: netlink: update netlink specs link

 Documentation/conf.py                         | 7 +++++--
 Documentation/userspace-api/netlink/index.rst | 2 +-
 Documentation/userspace-api/netlink/specs.rst | 2 +-
 3 files changed, 7 insertions(+), 4 deletions(-)

-- 
2.49.0
Re: [PATCH v2 0/2] Some extra patches for netlink doc generation
Posted by Donald Hunter 3 months, 4 weeks ago
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> This patch series comes after:
> 	https://lore.kernel.org/linux-doc/cover.1749723671.git.mchehab+huawei@kernel.org/T/#t

Can you please incorporate this series into a v3 of the other patch set.
Re: [PATCH v2 0/2] Some extra patches for netlink doc generation
Posted by Mauro Carvalho Chehab 3 months, 4 weeks ago
Em Fri, 13 Jun 2025 09:24:43 +0100
Donald Hunter <donald.hunter@gmail.com> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > This patch series comes after:
> > 	https://lore.kernel.org/linux-doc/cover.1749723671.git.mchehab+huawei@kernel.org/T/#t  
> 
> Can you please incorporate this series into a v3 of the other patch set.

Sure. Will send it in a few.

Thanks,
Mauro
Re: [PATCH v2 0/2] Some extra patches for netlink doc generation
Posted by Mauro Carvalho Chehab 4 months ago
Em Thu, 12 Jun 2025 15:41:29 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> escreveu:

> This patch series comes after:
> 	https://lore.kernel.org/linux-doc/cover.1749723671.git.mchehab+huawei@kernel.org/T/#t	
> The first patch is meant to speedup glob time by not adding all yaml to the parser.
> 
> The second one adjusts the location of netlink/specs/index.rst.
> 
> With that, on my AMD Ryzen 9 7900 machine, the time to do a full build after a
> cleanup is:
> 
> real    7m29,196s
> user    14m21,893s
> sys     2m28,510s

Heh, funny enough, my laptop with i5-10210U CPU @ 1.60GHz builds it faster:

real	6m2,075s
user	18m47,334s
sys	1m24,931s

Both are running Sphinx version 8.1.3 with standard Fedora package. At my
laptop, this is a bit slower than no using the extension:

real	5m13,334s
user	15m56,441s
sys	1m4,072s

but it is a lot cleaner, as, with the original way, there are several
warnings after make cleandocs:

	Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`rt-link<../../networking/netlink_spec/rt-link>`
	Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`tc<../../networking/netlink_spec/tc>`
	Documentation/userspace-api/netlink/netlink-raw.rst: :doc:`tc<../../networking/netlink_spec/tc>`
	Warning: Documentation/userspace-api/netlink/index.rst references a file that doesn't exist: Documentation/networking/netlink_spec/index.rst
	Warning: Documentation/userspace-api/netlink/specs.rst references a file that doesn't exist: Documentation/networking/netlink_spec/index.rst
	Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/firmware/intel,stratix10-svc.txt

Because they refer to the temp .rst source files generated inside
the source directory by the yaml conversion script.

Regards,
Mauro