Add patch to make documentation reproducible

diff --git a/debian/patches/reproducible_docs.patch b/debian/patches/reproducible_docs.patch
new file mode 100644 (file)
index 0000000..874bae4
--- /dev/null
+++ b/debian/patches/reproducible_docs.patch
@@ -0,0 +1,30 @@
+Description: make Doxygen documentation reproducible
+ Python's os.listdir() returns the entries in an undefined order,
+ which in turn makes the generated documentation unreproducible.
+ this patch just sorts the entries returned by os.listdir()
+Author: IOhannes m zmölnig
+Origin: Debian
+Forwarded: no
+Last-Update: 2022-11-10
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+--- juce.orig/docs/doxygen/process_source_files.py
++++ juce/docs/doxygen/process_source_files.py
+@@ -87,7 +87,7 @@
+         juce_modules = args.subdirs.split(",")
+     else:
+         juce_modules = []
+-        for item in os.listdir(args.source_dir):
++        for item in sorted(os.listdir(args.source_dir)):
+             if os.path.isdir(os.path.join(args.source_dir, item)):
+                 juce_modules.append(item)
+ 
+@@ -136,7 +136,7 @@
+ 
+         # Create a list of the directories in the module that we can use as
+         # subgroups and create the Doxygen group hierarchy string.
+-        dir_contents = os.listdir(module_path)
++        dir_contents = sorted(os.listdir(module_path))
+         # Ignore "native" folders as these are excluded by doxygen.
+         try:
+             dir_contents.remove("native")

diff --git a/debian/patches/series b/debian/patches/series
index cfe48f54a6594c11e9255575e3af3853a464e889..47db8b2b9f83a75db00d04331ffb57658d99d838 100644 (file)
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -3,6 +3,7 @@ debian_no-update-check.patch
 debian_system_modules.patch
 debian_python3-doxygen.patch
 debian_doxygen-outdir.patch
+reproducible_docs.patch
 debian_unittests_globalpaths.patch
 debian_link_systemlibs.patch
 debian_buildcmake.patch