mbox series

[0/8] Parallel docs build improvements

Message ID 20251222-concurrent-safety-v1-0-e3d86e44cd38@bootlin.com
Headers show
Series Parallel docs build improvements | expand

Message

Antonin Godard Dec. 22, 2025, 12:27 p.m. UTC
The aim of this series is to take the work of Quentin[1] and with
additional commit that improve the concurrent safety of the docs build,
and some general improvements to the build-docs-container script.

This allows building the docs on all supported distros with this bash
snippet:

```
declare -a distros=( $(./documentation/tools/build-docs-container supported_distros) )

for distro in "${distros[@]}"; do
  ./documentation/tools/build-docs-container $distro "$target" >/tmp/docs-build-"$distro".log 2>&1 &
done

wait
```

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (6):
      tools/build-docs-container: build in separate directory for each distro
      tools/build-docs-container: create symlink to latest build output
      Makefile: wrap set_versions.py with flock
      tools/build-docs-container: allow running non-interactively
      tools/build-docs-container: allow passing extra args to $OCI run
      tools/build-docs-container: make it possible to print the distro list

Quentin Schulz (2):
      tools/build-docs-container: guarantee the image to run matches the just-built image
      Makefile: allow to specify build directory

 documentation/.gitignore                 |  1 +
 documentation/Makefile                   | 10 ++--
 documentation/tools/build-docs-container | 90 +++++++++++++++++++++++---------
 3 files changed, 71 insertions(+), 30 deletions(-)
---
base-commit: f9042e1da554017fe46460c1fd2bdf8c74b3fa18
change-id: 20251218-concurrent-safety-e3a1a2394064

Comments

Quentin Schulz Jan. 9, 2026, 5:06 p.m. UTC | #1
Hi Antonin,

On 12/22/25 1:27 PM, Antonin Godard wrote:
> The aim of this series is to take the work of Quentin[1] and with
> additional commit that improve the concurrent safety of the docs build,
> and some general improvements to the build-docs-container script.
> 
> This allows building the docs on all supported distros with this bash
> snippet:
> 
> ```
> declare -a distros=( $(./documentation/tools/build-docs-container supported_distros) )
> 
> for distro in "${distros[@]}"; do
>    ./documentation/tools/build-docs-container $distro "$target" >/tmp/docs-build-"$distro".log 2>&1 &
> done
> 
> wait
> ```
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
> Antonin Godard (6):
>        tools/build-docs-container: build in separate directory for each distro
>        tools/build-docs-container: create symlink to latest build output
>        Makefile: wrap set_versions.py with flock
>        tools/build-docs-container: allow running non-interactively
>        tools/build-docs-container: allow passing extra args to $OCI run
>        tools/build-docs-container: make it possible to print the distro list
> 
> Quentin Schulz (2):
>        tools/build-docs-container: guarantee the image to run matches the just-built image
>        Makefile: allow to specify build directory
> 

Those are not following (kernel) contribution requirements.

See 
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin

Anyone who *sends* a patch need to add their SoB (at the end of the list 
of SoBs, Rbs, etc...) even if they are not the author (who needs to be 
the "first" SoB; see exceptions in the Co-developed-by: section 
underneath the section I linked just above (I don't understand the 
exceptions but I rarely have to add Co-developed-by so it's not been an 
issue for me so far)).

We don't document this in 
https://docs.yoctoproject.org/contributor-guide/submit-changes.html 
(possibly because people rarely take over patches in Yocto?).

Cheers,
Quentin