From 8a6065d53dcbc1f0cedd6925681b43c9c5e0b890 Mon Sep 17 00:00:00 2001
From: xengineering <me@xengineering.eu>
Date: Sun, 21 Jan 2024 09:28:01 +0100
Subject: doc: Add license text as appendix

The text of each used license is added to the documentation PDF since
this might be passed to third parties without the source or build tree.
Adding the licenses to the PDF makes sure they are always accessible.
---
 Makefile                              | 4 ++++
 doc/doc.mk                            | 2 +-
 doc/documentation.tex                 | 6 ++++++
 doc/license-latex-compatibility.patch | 8 ++++++++
 4 files changed, 19 insertions(+), 1 deletion(-)
 create mode 100644 doc/license-latex-compatibility.patch

diff --git a/Makefile b/Makefile
index 729e61a..bd8c14e 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,5 @@
 BUILD_DIR := ./build
+LICENSE := $(BUILD_DIR)/LICENSE.txt
 DATE := $(BUILD_DIR)/date.txt
 VERSION_FILE := $(BUILD_DIR)/version.txt
 ARTIFACTS_DIR := $(BUILD_DIR)/artifacts
@@ -10,6 +11,9 @@ ARCHIVE := $(ARTIFACTS_DIR)/$(TARGET_NAME).tar.zst
 
 all: $(ARCHIVE) $(VERSIONED_DOC)
 
+$(LICENSE):
+	cp LICENSE.txt $@
+
 .PHONY: $(DATE)
 $(DATE):
 	git show -s --format=%cs > $@
diff --git a/doc/doc.mk b/doc/doc.mk
index 8994824..79fe754 100644
--- a/doc/doc.mk
+++ b/doc/doc.mk
@@ -9,7 +9,7 @@ IMAGES := $(DIAGRAMS:%=$(DIAGRAMS_BUILD_DIR)/%.pdf)
 .PHONY: doc
 doc: $(DOCUMENTS)
 
-$(DOC_BUILD_DIR)/%.pdf: doc/%.tex $(IMAGES) $(DATE) $(VERSION_FILE)
+$(DOC_BUILD_DIR)/%.pdf: doc/%.tex $(IMAGES) $(DATE) $(VERSION_FILE) $(LICENSE)
 	mkdir -p $(dir $@)
 	pdflatex -halt-on-error -output-directory $(DOC_BUILD_DIR) $<
 	pdflatex -halt-on-error -output-directory $(DOC_BUILD_DIR) $<
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 5dd13a6..95387c2 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -412,4 +412,10 @@ internals at all. Devices can be seen as atomic from a user's perspective. This
 level of granularity is choosen because users are not expected to disassemble
 devices or to care about the software internals.
 
+\appendix
+
+\chapter{CERN Open Hardware Licence}
+
+\texttt{\input{../LICENSE.txt}}
+
 \end{document}
diff --git a/doc/license-latex-compatibility.patch b/doc/license-latex-compatibility.patch
new file mode 100644
index 0000000..e697c64
--- /dev/null
+++ b/doc/license-latex-compatibility.patch
@@ -0,0 +1,8 @@
+36c36
+<     wiki.creativecommons.org/Considerations_for_licensors
+---
+>     wiki.creativecommons.org/Considerations\_for\_licensors
+53c53
+<     wiki.creativecommons.org/Considerations_for_licensees
+---
+>     wiki.creativecommons.org/Considerations\_for\_licensees
-- 
cgit v1.2.3-70-g09d2