Skip to contentSkip to conversation

docs: add +x to generator scripts

PATCH In review [email protected] 3 participants 5 messages Nov 14, 2022 – Nov 22, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 docs: add +x to generator scripts

From: Luca Boccassi <[email protected]>

These scripts have a shebang so they are meant to be runnable, so set +x bits

Fixes 53bb9a073f4f ("doc: rewrite shell scripts in Python")
---
 doc/api/generate_doxygen.py  | 0
 doc/api/generate_examples.py | 0
 2 files changed, 0 insertions(+), 0 deletions(-)
 mode change 100644 => 100755 doc/api/generate_doxygen.py
 mode change 100644 => 100755 doc/api/generate_examples.py
doc/api/generate_doxygen.py +0 -0
old mode 100644
new mode 100755
doc/api/generate_examples.py +0 -0
old mode 100644
new mode 100755
Signature · 1 line
2.34.1
#1 lore raw

PATCH 2/2 docs: sort files lists in generator scripts

From: Luca Boccassi <[email protected]>

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")
---
 doc/api/generate_doxygen.py  | 2 +-
 doc/api/generate_examples.py | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
doc/api/generate_doxygen.py +1 -1
index 2ccedf844e..d3a22869f6 100755
@@ -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)
doc/api/generate_examples.py +2 -2
index c35e72f280..7315b3c356 100755
@@ -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('\\', '/')
Signature · 1 line
2.34.1
Acked-by on v1 2/2
#2 lore raw

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

Quoted 11 lines · On Mon, Nov 14, 2022 at 02:22:25PM +0000, [email protected] wrote:

From: Luca Boccassi <[email protected]>

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")

---

Seems reasonable.

#3 lore raw

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

14/11/2022 15:29, Bruce Richardson:

Quoted 8 lines · On Mon, Nov 14, 2022 at 02:22:25PM +0000, [email protected] wrote:
Quoted 7 lines

From: Luca Boccassi <[email protected]>

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.

Quoted 8 lines
Quoted 4 lines
Fixes 53bb9a073f4f ("doc: rewrite shell scripts in Python")

---

Seems reasonable.

Series applied, thanks.

Acked-by on v1 1/2
#4 lore raw
In reply to [email protected]

doc/api/generate_examples.py

Quoted 21 lines · On Mon, Nov 14, 2022 at 02:22:24PM +0000, [email protected] wrote:

From: Luca Boccassi <[email protected]>

These scripts have a shebang so they are meant to be runnable, so set +x bits

Fixes 53bb9a073f4f ("doc: rewrite shell scripts in Python")
---
 doc/api/generate_doxygen.py  | 0
 doc/api/generate_examples.py | 0
 2 files changed, 0 insertions(+), 0 deletions(-)
 mode change 100644 => 100755 doc/api/generate_doxygen.py
 mode change 100644 => 100755 doc/api/generate_examples.py
doc/api/generate_doxygen.py +0 -0
old mode 100644
new mode 100755
doc/api/generate_examples.py +0 -0
old mode 100644
new mode 100755