From: Steffan Karger Date: Wed, 8 Nov 2017 12:12:54 +0000 (+0100) Subject: doxygen: add make target and use relative paths X-Git-Tag: v2.5_beta1~565 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=66bf378e;p=thirdparty%2Fopenvpn.git doxygen: add make target and use relative paths Add a make target, such that 'make doxygen' works (both for in-tree and out-of-tree builds). This now generates the doxygen in doc/doxygen/, rather than in doxygen/. While doing so, instead of genering docs with full path names (e.g. /home/steffan/dev/openvpn/src/openvpn/crypto.h), use a relative path wrt the project root (e.g. src/openvpn/crypto.h) in the generated documentation. This makes the generated doxygen easier to read. Signed-off-by: Steffan Karger Acked-by: Gert Doering Message-Id: <1510143174-15248-1-git-send-email-steffan.karger@fox-it.com> URL: https://www.mail-archive.com/search?l=mid&q=1510143174-15248-1-git-send-email-steffan.karger@fox-it.com Signed-off-by: Gert Doering --- diff --git a/.gitignore b/.gitignore index 454367483..18a452022 100644 --- a/.gitignore +++ b/.gitignore @@ -34,7 +34,6 @@ config.sub configure configure.h depcomp -doxygen/ stamp-h1 install-sh missing @@ -51,6 +50,8 @@ msvc-env-local.bat config-msvc-local.h config-msvc-version.h doc/openvpn.8.html +/doc/doxygen/html/ +/doc/doxygen/latex/ distro/rpm/openvpn.spec distro/systemd/*.service sample/sample-keys/sample-ca/ diff --git a/Makefile.am b/Makefile.am index 87af7241d..773b7867e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -46,7 +46,7 @@ EXTRA_DIST = \ contrib \ debug -.PHONY: config-version.h +.PHONY: config-version.h doxygen if GIT_CHECKOUT BUILT_SOURCES = \ @@ -96,3 +96,6 @@ config-version.h: else \ rm -f config-version.h.tmp; \ fi + +doxygen: + $(MAKE) -C doc/doxygen doxygen diff --git a/configure.ac b/configure.ac index 45aa5017b..7f2e34f2c 100644 --- a/configure.ac +++ b/configure.ac @@ -1420,6 +1420,9 @@ AC_CONFIG_FILES([ distro/rpm/Makefile distro/rpm/openvpn.spec distro/systemd/Makefile + doc/Makefile + doc/doxygen/Makefile + doc/doxygen/openvpn.doxyfile include/Makefile src/Makefile src/compat/Makefile @@ -1436,7 +1439,6 @@ AC_CONFIG_FILES([ tests/unit_tests/plugins/auth-pam/Makefile vendor/Makefile sample/Makefile - doc/Makefile ]) AC_CONFIG_FILES([tests/t_client.sh], [chmod +x tests/t_client.sh]) AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am index dedd1fa5c..f9e7f4ae1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -14,6 +14,8 @@ MAINTAINERCLEANFILES = \ CLEANFILES = openvpn.8.html +SUBDIRS = doxygen + dist_doc_DATA = \ management-notes.txt diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am new file mode 100644 index 000000000..def097894 --- /dev/null +++ b/doc/doxygen/Makefile.am @@ -0,0 +1,21 @@ +# +# OpenVPN -- An application to securely tunnel IP networks +# over a single UDP port, with support for SSL/TLS-based +# session authentication and key exchange, +# packet encryption, packet authentication, and +# packet compression. +# +# Copyright (C) 2017 Fox-IT B.V. +# + +MAINTAINERCLEANFILES = \ + $(srcdir)/Makefile.in + +DISTCLEANFILES = openvpn.doxyfile + +.PHONY: doxygen +doxygen: openvpn.doxyfile + doxygen openvpn.doxyfile + +clean-local: + -rm -rf html latex diff --git a/doc/doxygen/openvpn.doxyfile b/doc/doxygen/openvpn.doxyfile.in similarity index 98% rename from doc/doxygen/openvpn.doxyfile rename to doc/doxygen/openvpn.doxyfile.in index a7d9728ea..bb56fff4a 100644 --- a/doc/doxygen/openvpn.doxyfile +++ b/doc/doxygen/openvpn.doxyfile.in @@ -6,7 +6,7 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "OpenVPN" PROJECT_NUMBER = -OUTPUT_DIRECTORY = doxygen +OUTPUT_DIRECTORY = "@abs_top_builddir@/doc/doxygen" CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES @@ -25,7 +25,7 @@ ABBREVIATE_BRIEF = "The $name class" \ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES -STRIP_FROM_PATH = "" +STRIP_FROM_PATH = "@abs_top_srcdir@" STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES # NO @@ -90,7 +90,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = . +INPUT = "@abs_top_srcdir@" INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.c \ *.cc \