[Openvpn-devel,1/3] doc/Makefile: rebuild rst docs if input files change

Message ID 20211209171138.8589-1-frank@lichtenheld.com
State Accepted
Headers show
Series
  • [Openvpn-devel,1/3] doc/Makefile: rebuild rst docs if input files change
Related show

Commit Message

Frank Lichtenheld Dec. 9, 2021, 5:11 p.m.
For now the dependencies are statically defined, which
should be fine and is still a much better solution than
to have no dependencies.

Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
---
 doc/Makefile.am | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

Comments

David Sommerseth Feb. 9, 2022, 10:20 p.m. | #1
On 09/12/2021 18:11, Frank Lichtenheld wrote:
> For now the dependencies are statically defined, which
> should be fine and is still a much better solution than
> to have no dependencies.
> 
> Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
> ---
>   doc/Makefile.am | 21 +++++++++++++++------
>   1 file changed, 15 insertions(+), 6 deletions(-)
> 

Done code review and lightly tested it, where it does what it is 
intended to do.  This change makes a lot of sense as well.

Acked-By: David Sommerseth <davids@openvpn.net>
Gert Doering Feb. 10, 2022, 7:54 a.m. | #2
Your patch has been applied to the master branch.

I think it makes sense for release/2.5 as well, but the Makefile looks
a bit different there (no examples-fingerprint.rst at least, did not
look into it more in detail).

commit 529cc6a52fc45a1a67abb5c91819ba4fb2f631e3
Author: Frank Lichtenheld
Date:   Thu Dec 9 18:11:36 2021 +0100

     doc/Makefile: rebuild rst docs if input files change

     Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
     Acked-by: David Sommerseth <davids@openvpn.net>
     Message-Id: <20211209171138.8589-1-frank@lichtenheld.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg23369.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1a67f7b5..a31b8097 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -23,16 +23,11 @@  build_html_pages = openvpn.8.html openvpn-examples.5.html
 dist_doc_DATA = \
 	management-notes.txt gui-notes.txt
 
-dist_noinst_DATA = \
-	README.plugins interactive-service-notes.rst \
-	openvpn.8.rst \
-	openvpn-examples.5.rst \
+openvpn_sections = \
 	man-sections/advanced-options.rst \
 	man-sections/client-options.rst \
 	man-sections/connection-profiles.rst \
 	man-sections/encryption-options.rst \
-	man-sections/example-fingerprint.rst \
-	man-sections/examples.rst \
 	man-sections/generic-options.rst \
 	man-sections/inline-files.rst \
 	man-sections/link-options.rst \
@@ -53,6 +48,20 @@  dist_noinst_DATA = \
 	man-sections/vpn-network-options.rst \
 	man-sections/windows-options.rst
 
+openvpn_examples_sections = \
+	man-sections/example-fingerprint.rst \
+	man-sections/examples.rst
+
+dist_noinst_DATA = \
+	README.plugins interactive-service-notes.rst \
+	openvpn.8.rst \
+	openvpn-examples.5.rst \
+	$(openvpn_sections) \
+	$(openvpn_examples_sections)
+
+# dependencies
+openvpn.8 openvpn.8.html: $(openvpn_sections)
+openvpn-examples.5 openvpn-examples.5.html: $(openvpn_examples_sections)
 
 ######  GENERIC  RULES  ##########