mirror of
https://github.com/OpenVPN/openvpn.git
synced 2024-09-20 03:52:28 +02:00
doc: Use generic rules for man/html generation
Prior to this patch, the Makefile.am needs to be modified multiple places to add a new man or HTML page to be generated. Since it is not too often we modify this, it is easy to miss these finer details. This changes the man and HTML generator rules to be more generic and use variables as many places as possible. Also moved all the lines which should not need to be changed as much towards the bottom-half of the file. Signed-off-by: David Sommerseth <davids@openvpn.net> Acked-by: Gert Doering <gert@greenie.muc.de> Message-Id: <20210630185134.144826-1-openvpn@sf.lists.topphemmelig.net> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22604.html Signed-off-by: Gert Doering <gert@greenie.muc.de>
This commit is contained in:
parent
0c5380e906
commit
37cf98fa22
@ -9,11 +9,17 @@
|
||||
# Copyright (C) 2006-2012 Alon Bar-Lev <alon.barlev@gmail.com>
|
||||
#
|
||||
|
||||
MAINTAINERCLEANFILES = \
|
||||
$(srcdir)/Makefile.in
|
||||
|
||||
SUBDIRS = doxygen
|
||||
|
||||
#
|
||||
# List of man and HTML pages we build when rst2man/rst2html is available
|
||||
#
|
||||
# NOTE: Remember to add source .rst files to $(dist_noinst_DATA) below
|
||||
# This could be automated with GNU Make, but we need BSD Make support
|
||||
#
|
||||
build_man_pages = openvpn.8 openvpn-examples.5
|
||||
build_html_pages = openvpn.8.html openvpn-examples.5.html
|
||||
|
||||
dist_doc_DATA = \
|
||||
management-notes.txt gui-notes.txt
|
||||
|
||||
@ -46,49 +52,41 @@ dist_noinst_DATA = \
|
||||
man-sections/vpn-network-options.rst \
|
||||
man-sections/windows-options.rst
|
||||
|
||||
openvpn.8 :
|
||||
|
||||
###### GENERIC RULES ##########
|
||||
|
||||
SUFFIXES = .8.rst .8 .8.html .5.rst .5 .5.html
|
||||
|
||||
MAINTAINERCLEANFILES = \
|
||||
$(srcdir)/Makefile.in
|
||||
|
||||
.8.rst.8 .5.rst.5 :
|
||||
if HAVE_PYDOCUTILS
|
||||
$(RST2MAN) $(srcdir)/$@.rst > $@
|
||||
$(RST2MAN) $< > $@
|
||||
else
|
||||
@echo "Missing python-docutils - skipping man page generation"
|
||||
@echo "Missing python-docutils - skipping man page generation ($@)"
|
||||
endif
|
||||
|
||||
openvpn-examples.5 :
|
||||
.8.rst.8.html .5.rst.5.html :
|
||||
if HAVE_PYDOCUTILS
|
||||
$(RST2MAN) $(srcdir)/$@.rst > $@
|
||||
$(RST2HTML) $< > $@
|
||||
else
|
||||
@echo "Missing python-docutils - skipping man page generation"
|
||||
endif
|
||||
|
||||
|
||||
openvpn.8.html:
|
||||
if HAVE_PYDOCUTILS
|
||||
$(RST2HTML) $(srcdir)/openvpn.8.rst > $@
|
||||
else
|
||||
@echo "Missing python-docutils - skipping man/html page generation"
|
||||
endif
|
||||
|
||||
openvpn-examples.5.html:
|
||||
if HAVE_PYDOCUTILS
|
||||
$(RST2HTML) $(srcdir)/openvpn-examples.5.rst > $@
|
||||
else
|
||||
@echo "Missing python-docutils - skipping man/html page generation"
|
||||
@echo "Missing python-docutils - skipping html page generation ($@)"
|
||||
endif
|
||||
|
||||
|
||||
if HAVE_PYDOCUTILS
|
||||
dist_noinst_DATA += openvpn.8 openvpn-examples.5
|
||||
dist_html_DATA = openvpn.8.html openvpn-examples.5.html
|
||||
dist_noinst_DATA += $(build_man_pages)
|
||||
dist_html_DATA = $(build_html_pages)
|
||||
|
||||
# Failsafe - do not delete these files unless we can recreate them
|
||||
CLEANFILES = \
|
||||
openvpn.8 openvpn.8.html openvpn-examples.5 openvpn-examples.5.html
|
||||
CLEANFILES = $(build_man_pages) $(build_html_pages)
|
||||
|
||||
endif
|
||||
|
||||
if WIN32
|
||||
else
|
||||
dist_man_MANS = openvpn.8 openvpn-examples.5
|
||||
dist_man_MANS = $(build_man_pages)
|
||||
endif
|
||||
|
||||
dist-hook : openvpn.8 openvpn.8.html openvpn-examples.5 openvpn-examples.5.html
|
||||
dist-hook : $(build_man_pages) $(build_html_pages)
|
||||
|
Loading…
Reference in New Issue
Block a user