From: Pablo Neira Ayuso <pablo@netfilter.org>
To: netfilter-devel@vger.kernel.org
Subject: [PATCH libmnl] build: do not build documentation automatically
Date: Sat, 12 Oct 2024 19:15:21 +0200 [thread overview]
Message-ID: <20241012171521.33453-1-pablo@netfilter.org> (raw)
Make it option, after this update it is still possible to build the
documentation on demand via:
cd doxygen
make
if ./configure found doxygen. Otherwise, no need to build documentation
when building from source.
Update README to include this information.
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
---
Makefile.am | 2 +-
README | 10 ++++++++++
2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/Makefile.am b/Makefile.am
index 94e6935d6138..6ec1a7b98827 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,7 +2,7 @@ include $(top_srcdir)/Make_global.am
ACLOCAL_AMFLAGS = -I m4
-SUBDIRS = src include examples doxygen
+SUBDIRS = src include examples
DIST_SUBDIRS = src include examples doxygen
pkgconfigdir = $(libdir)/pkgconfig
diff --git a/README b/README
index 317a2c6ad1d6..c82dedd2266a 100644
--- a/README
+++ b/README
@@ -23,6 +23,16 @@ forced to use them.
You can find several example files under examples/ that you can compile by
invoking `make check'.
+= Documentation =
+
+If ./configure reports that doxygen has been found, then you can build
+documentation through:
+
+ cd doxygen
+ make
+
+then, open doxygen/html/index.html in your browser.
+
= Contributing =
Please submit any patches to <netfilter-devel@vger.kernel.org>.
--
2.30.2
next reply other threads:[~2024-10-12 17:15 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-12 17:15 Pablo Neira Ayuso [this message]
2024-10-12 19:54 ` [PATCH libmnl] build: do not build documentation automatically Phil Sutter
2024-10-12 21:26 ` Pablo Neira Ayuso
2024-10-12 23:03 ` Phil Sutter
2024-10-13 8:21 ` Pablo Neira Ayuso
2024-10-14 7:55 ` Duncan Roe
2024-10-14 8:09 ` Pablo Neira Ayuso
2024-10-14 11:12 ` Jan Engelhardt
2024-10-14 11:20 ` Pablo Neira Ayuso
[not found] ` <Zw8UOCbpwSOupUcf@slk15.local.net>
[not found] ` <Zw9qbppRAtX4VbIv@calendula>
2024-10-16 7:26 ` [PATCH libmnl v2] " Pablo Neira Ayuso
2024-10-17 23:59 ` Duncan Roe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20241012171521.33453-1-pablo@netfilter.org \
--to=pablo@netfilter.org \
--cc=netfilter-devel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).