From: Christian Ehrhardt <christian.ehrhardt@canonical.com>
To: dev <dev@dpdk.org>
Cc: Luca Boccassi <bluca@debian.org>
Subject: Re: [PATCH] doc: ensure sphinx output is reproducible
Date: Thu, 29 Jun 2023 15:02:45 +0200 [thread overview]
Message-ID: <CAATJJ0+eqDOTdWh2HNtfiTFTvv8437JuwsZm4nPK-Q5835-Zog@mail.gmail.com> (raw)
In-Reply-To: <20230629125838.1995751-1-christian.ehrhardt@canonical.com>
On Thu, Jun 29, 2023 at 2:58 PM <christian.ehrhardt@canonical.com> wrote:
>
> From: Christian Ehrhardt <christian.ehrhardt@canonical.com>
>
> By adding -j we build in parallel, to make building on multiprocessor
> machines more effective. While that works it does also break
> reproducible builds as the order of the sphinx generated searchindex.js
> is depending on execution speed of the individual processes.
Just FYI (this didn't fit fit well in the commit message) an example
of such a fail can be seen at
https://salsa.debian.org/paelzer-guest/dpdk/-/jobs/4372883
If you download the artifact, extract dpdk-doc, apply js-beautify for
readability and then diff it you'll find it
same-content-different-order.
Examples of two builds:
- https://paste.ubuntu.com/p/VhWYNRv7kN/
- https://paste.ubuntu.com/p/KcQk4Km9xM/
> Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> ---
> buildtools/call-sphinx-build.py | 5 -----
> 1 file changed, 5 deletions(-)
>
> diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py
> index 39a60d09fa..d8879306de 100755
> --- a/buildtools/call-sphinx-build.py
> +++ b/buildtools/call-sphinx-build.py
> @@ -15,12 +15,7 @@
> # set the version in environment for sphinx to pick up
> os.environ['DPDK_VERSION'] = version
>
> -# for sphinx version >= 1.7 add parallelism using "-j auto"
> -ver = run([sphinx, '--version'], stdout=PIPE,
> - stderr=STDOUT).stdout.decode().split()[-1]
> sphinx_cmd = [sphinx] + extra_args
> -if Version(ver) >= Version('1.7'):
> - sphinx_cmd += ['-j', 'auto']
>
> # find all the files sphinx will process so we can write them as dependencies
> srcfiles = []
> --
> 2.41.0
>
--
Christian Ehrhardt
Senior Staff Engineer and acting Director, Ubuntu Server
Canonical Ltd
next prev parent reply other threads:[~2023-06-29 13:03 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-29 12:58 christian.ehrhardt
2023-06-29 13:02 ` Christian Ehrhardt [this message]
2023-07-03 15:29 ` Thomas Monjalon
2023-07-06 12:49 ` Christian Ehrhardt
2023-11-27 16:45 ` Thomas Monjalon
2023-11-27 17:00 ` Bruce Richardson
2024-05-17 11:29 ` Luca Boccassi
2024-05-19 13:54 ` Thomas Monjalon
2024-05-19 16:36 ` Luca Boccassi
2024-05-19 17:13 ` Thomas Monjalon
2024-05-19 17:23 ` Luca Boccassi
2024-05-19 21:10 ` Thomas Monjalon
2024-05-20 9:53 ` Luca Boccassi
2024-05-20 15:39 ` Stephen Hemminger
2024-05-20 18:59 ` Thomas Monjalon
2024-05-26 11:30 ` Thomas Monjalon
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=CAATJJ0+eqDOTdWh2HNtfiTFTvv8437JuwsZm4nPK-Q5835-Zog@mail.gmail.com \
--to=christian.ehrhardt@canonical.com \
--cc=bluca@debian.org \
--cc=dev@dpdk.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).