[Openvpn-devel,4/4] dist: Include all documentation in distribution

Message ID 20230619132934.76085-5-frank@lichtenheld.com
State Accepted
Headers show
Series Various dist-related fixes | expand

Commit Message

Frank Lichtenheld June 19, 2023, 1:29 p.m. UTC
No need to deprive tar ball users of this information.

Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
---
 Makefile.am             |  5 ++++-
 doc/Makefile.am         |  9 ++++++++-
 doc/doxygen/Makefile.am | 21 ++++++++++++++++++++-
 3 files changed, 32 insertions(+), 3 deletions(-)

Comments

Gert Doering June 21, 2023, 12:50 p.m. UTC | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

"Makes sense".  If we have all these nice files, so well maintained, 
why not share them.

(We might want to have a look into these doxygen files and see if part
of the documentation has become stale over time... I have not seen
any updates in a long time, except for copyright year changes)

Your patch has been applied to the master branch.

commit 9ccb14970387d7c13589b85b0ca7048cebf52c6d (master)
commit bf5c5dee7cdc189660ad35e9aaecf4aea5aec4cf (release/2.6)
Author: Frank Lichtenheld
Date:   Mon Jun 19 15:29:34 2023 +0200

     dist: Include all documentation in distribution

     Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <20230619132934.76085-5-frank@lichtenheld.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg26749.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/Makefile.am b/Makefile.am
index 297c3399..27da974d 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -62,8 +62,11 @@  dist_doc_DATA = \
 dist_noinst_DATA = \
 	.gitignore \
 	.gitattributes \
+	CONTRIBUTING.rst \
 	PORTS \
-	README.mbedtls \
+	README.dco.md \
+	README.ec \
+	README.wolfssl \
 	openvpn.sln
 
 dist_noinst_HEADERS = \
diff --git a/doc/Makefile.am b/doc/Makefile.am
index bb9c935d..d8ffe2e0 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -54,12 +54,19 @@  openvpn_examples_sections = \
 	man-sections/examples.rst
 
 dist_noinst_DATA = \
-	README.plugins interactive-service-notes.rst \
+	android.txt \
+	interactive-service-notes.rst \
+	keying-material-exporter.txt \
 	openvpn.8.rst \
 	openvpn-examples.5.rst \
+	README.man \
+	README.plugins \
+	tls-crypt-v2.txt \
 	$(openvpn_sections) \
 	$(openvpn_examples_sections)
 
+EXTRA_DIST = tests
+
 # dependencies
 openvpn.8 openvpn.8.html: $(openvpn_sections)
 openvpn-examples.5 openvpn-examples.5.html: $(openvpn_examples_sections)
diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
index 82d909dd..ec1045eb 100644
--- a/doc/doxygen/Makefile.am
+++ b/doc/doxygen/Makefile.am
@@ -13,8 +13,27 @@  MAINTAINERCLEANFILES = \
 
 DISTCLEANFILES = openvpn.doxyfile
 
+DOXYGEN_EXTRA_FILES = \
+	doc_compression.h \
+	doc_control_processor.h \
+	doc_control_tls.h \
+	doc_data_control.h \
+	doc_data_crypto.h \
+	doc_eventloop.h \
+	doc_external_multiplexer.h \
+	doc_fragmentation.h \
+	doc_internal_multiplexer.h \
+	doc_key_generation.h \
+	doc_mainpage.h \
+	doc_memory_management.h \
+	doc_protocol_overview.h \
+	doc_reliable.h \
+	doc_tunnel_state.h
+
+EXTRA_DIST = $(DOXYGEN_EXTRA_FILES)
+
 .PHONY: doxygen
-doxygen: openvpn.doxyfile
+doxygen: openvpn.doxyfile $(DOXYGEN_EXTRA_FILES)
 	doxygen openvpn.doxyfile
 
 clean-local: