From fac23f030cd87a5a7ba57e72157c0db03e331d30 Mon Sep 17 00:00:00 2001 From: Luca Boccassi Date: Mon, 14 Nov 2022 14:22:25 +0000 Subject: [PATCH] doc: sort file lists in API generators 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") Cc: stable@dpdk.org Signed-off-by: Luca Boccassi Acked-by: Bruce Richardson --- doc/api/generate_doxygen.py | 2 +- doc/api/generate_examples.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) 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('\\', '/')