diff mbox series

[2/2] docs: sort files lists in generator scripts

Message ID 20221114142225.85403-2-luca.boccassi@gmail.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [1/2] docs: add +x to generator scripts |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/github-robot: build success github build: passed
ci/intel-Testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS

Commit Message

Luca Boccassi Nov. 14, 2022, 2:22 p.m. UTC 
  From: Luca Boccassi <bluca@debian.org>

In order to build the documentation in a reproducible manner, sort the lists of
files used as input, since walking the filesystem is not guaranteed to be done
in a stable order.
When converting the scripts from shell to python, sorting the input was lost.

Fixes: 53bb9a073f4f ("doc: rewrite shell scripts in Python")

Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 doc/api/generate_doxygen.py  | 2 +-
 doc/api/generate_examples.py | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

Comments

Bruce Richardson Nov. 14, 2022, 2:29 p.m. UTC | #1 
On Mon, Nov 14, 2022 at 02:22:25PM +0000, luca.boccassi@gmail.com wrote:
> From: Luca Boccassi <bluca@debian.org>
> 
> In order to build the documentation in a reproducible manner, sort the lists of
> files used as input, since walking the filesystem is not guaranteed to be done
> in a stable order.
> When converting the scripts from shell to python, sorting the input was lost.
> 
> Fixes: 53bb9a073f4f ("doc: rewrite shell scripts in Python")
> 
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---

Seems reasonable.

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Thomas Monjalon Nov. 22, 2022, 2:27 p.m. UTC | #2 
14/11/2022 15:29, Bruce Richardson:
> On Mon, Nov 14, 2022 at 02:22:25PM +0000, luca.boccassi@gmail.com wrote:
> > From: Luca Boccassi <bluca@debian.org>
> > 
> > In order to build the documentation in a reproducible manner, sort the lists of
> > files used as input, since walking the filesystem is not guaranteed to be done
> > in a stable order.
> > When converting the scripts from shell to python, sorting the input was lost.
> > 
> > Fixes: 53bb9a073f4f ("doc: rewrite shell scripts in Python")
> > 
> > Signed-off-by: Luca Boccassi <bluca@debian.org>
> > ---
> 
> Seems reasonable.
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Series applied, thanks.
diff mbox series

Patch

diff --git a/doc/api/generate_doxygen.py b/doc/api/generate_doxygen.py
index 2ccedf844e..d3a22869f6 100755
--- a/doc/api/generate_doxygen.py
+++ b/doc/api/generate_doxygen.py
@@ -13,7 +13,7 @@ 
     subprocess.run(doxygen_command, check=True, stdout=out)
 with open(out_file) as out, open(dep_file, 'w') as dep:
     print(f'{out_dir}:', end=' ', file=dep)
-    for line in out:
+    for line in sorted(out):
         match = re.match(pattern, line)
         if match:
             print(match.group(1), end=' ', file=dep)
diff --git a/doc/api/generate_examples.py b/doc/api/generate_examples.py
index c35e72f280..7315b3c356 100755
--- a/doc/api/generate_examples.py
+++ b/doc/api/generate_examples.py
@@ -11,7 +11,7 @@ 
 with open(f'{api_examples}.d', 'w') as dep:
     print(f'{api_examples}:', end=' ', file=dep)
     for root, _, files in os.walk(examples_dir):
-        for name in files:
+        for name in sorted(files):
             is_source = name.endswith('.c')
             if is_source or name == 'meson.build':
                 path = os.path.join(root, name)
@@ -23,7 +23,7 @@ 
     print('''/**
 @page examples DPDK Example Programs
 ''', file=out)
-    for path in sources:
+    for path in sorted(sources):
         # Produce consistent output with forward slashes on all systems.
         # Every \ in paths within examples directory is a separator, not escape.
         relpath = os.path.relpath(path, examples_dir).replace('\\', '/')