diff options
| author | Pablo Neira Ayuso <pablo@netfilter.org> | 2024-10-13 10:46:41 +0200 |
|---|---|---|
| committer | Pablo Neira Ayuso <pablo@netfilter.org> | 2024-10-14 12:14:47 +0200 |
| commit | 537e7df7cb6ddb51b73a9344b7aeb31e3121c30b (patch) | |
| tree | 96dab33c978d386be23888aad44345a7e038c88b | |
| parent | f066fabaa3088ba6b28aae9f0f7448242b56d4c6 (diff) | |
build: do not build documentation automatically
Make it optional. After this update it is still possible to build the
documentation via:
./configure --with-doxygen=yes
if ./configure finds doxygen. Update README to include this information.
Acked-by: Phil Sutter <phil@nwl.cc>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
| -rw-r--r-- | README | 11 | ||||
| -rw-r--r-- | configure.ac | 2 |
2 files changed, 12 insertions, 1 deletions
@@ -18,6 +18,17 @@ on top of this library. is reduced, i.e. the library provides many helpers, but the programmer is not forced to use them. += Documentation = + +If doxygen is installed on your system, you can enable it via: + + ./configure --with-doxygen=yes + +then type `make`. + +To access the doxygen documentation, open the doxygen/html/index.html file with +a web browser. + = Example files = You can find several example files under examples/ that you can compile by diff --git a/configure.ac b/configure.ac index 4698aec..9305766 100644 --- a/configure.ac +++ b/configure.ac @@ -45,7 +45,7 @@ AC_CONFIG_FILES([Makefile AC_ARG_WITH([doxygen], [AS_HELP_STRING([--with-doxygen], [create doxygen documentation])], - [with_doxygen="$withval"], [with_doxygen=yes]) + [with_doxygen="$withval"], [with_doxygen=no]) AS_IF([test "x$with_doxygen" != xno], [ AC_CHECK_PROGS([DOXYGEN], [doxygen]) |