From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1DE54C433EF for ; Sat, 16 Oct 2021 07:52:38 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F183D60C51 for ; Sat, 16 Oct 2021 07:52:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S243826AbhJPHyo (ORCPT ); Sat, 16 Oct 2021 03:54:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34502 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239843AbhJPHyo (ORCPT ); Sat, 16 Oct 2021 03:54:44 -0400 Received: from mail-pj1-x1034.google.com (mail-pj1-x1034.google.com [IPv6:2607:f8b0:4864:20::1034]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 832C2C061570 for ; Sat, 16 Oct 2021 00:52:36 -0700 (PDT) Received: by mail-pj1-x1034.google.com with SMTP id g13-20020a17090a3c8d00b00196286963b9so10931679pjc.3 for ; Sat, 16 Oct 2021 00:52:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=sender:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=i9JpjL980ETRd4VL7Xi7Snxjf6CcVE6dT9gqdCL6Mbw=; b=IZk4EduD9kX3Fi9sJTytljqjpI9xGAEULPAkeGpKp+cAUxEsQez/qw0EemGvAZWKoX m/291hlWcwdU9MiwFAAk6+QP2wqeh/bGBMndb6ckOU9rJFbrOqCFenV9boKwIMsqvnCc EPFPByy5wTZpM7I44rWGMkOR8EgH2Is5kzMatE1YqQGIIhLunSkauu+itTDED2VCw39K zgui34BpYrLTq2oRjAGs9iUanHb1Ln3eoTPGRV29X9cadDgq+hpZxxA49HdTLe9lXfNU +r4y5+bGhi4zwDFvmUfpXh3M7uehrLcZQnUt5o2+oNRFLXUq3oK80PCtMcFemfmcJ8S1 6gXA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :mime-version:content-transfer-encoding; bh=i9JpjL980ETRd4VL7Xi7Snxjf6CcVE6dT9gqdCL6Mbw=; b=mnrnDDgt5btm8QI7bCRjI2J+t0wuLe0f4B2YfZiobvab9d89ryKT4YuSZGRyvSKdw6 EaLx7X2hq0v0dkOtgbqCXblzFX3YalQ++6zSN4SqdhjQpmspdEZz5qX/7uI4TfCv0WND pOpfO9XIACfXWXh1WtJxjpSBWSh31aSdcEbZtdn7Lu5GT311WTj6l8mTLKDdFqXFnmnq dMA3AnPDdJo7NeNjoqn2SdaDzavd8zQ8PBDUexRkt8dkg2YScla17SqnRUIC9ZPQyBeQ DANfbcCWFDZH9yMhe3dU8t1TigOxd+QEjivoWnHu6k0QvshfI+Ae8spe/p5F/JWakbOY SLkw== X-Gm-Message-State: AOAM533AkKjTnyakHjVOQLPiMiyQ6saL4TQr71U3g74bT7MIOQpqea5s A/8TECb+0MMAiUiEYGJ0prnFeg3eZqw= X-Google-Smtp-Source: ABdhPJzm1l9oMy1bAHGqX1JRg65nVQ9vUydLXYxzmU3JjzLQFSZS36GNQzN5OVpVqgy7+sSwJ2BMTw== X-Received: by 2002:a17:902:d904:b0:13f:398e:a0df with SMTP id c4-20020a170902d90400b0013f398ea0dfmr15259140plz.47.1634370756069; Sat, 16 Oct 2021 00:52:36 -0700 (PDT) Received: from slk1.local.net (n110-23-108-30.sun3.vic.optusnet.com.au. [110.23.108.30]) by smtp.gmail.com with ESMTPSA id y75sm6906077pfb.57.2021.10.16.00.52.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Oct 2021 00:52:35 -0700 (PDT) Sender: Duncan Roe From: Duncan Roe To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH libnetfilter_queue v5] build: doc: Allow to specify whether to produce man pages, html, neither or both Date: Sat, 16 Oct 2021 18:52:31 +1100 Message-Id: <20211016075231.11620-1-duncan_roe@optusnet.com.au> X-Mailer: git-send-email 2.32.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: netfilter-devel@vger.kernel.org - configure --help lists non-default documentation options. Looking around the web, this seemed to me to be what most projects do. Listed options are --enable-html-doc & --disable-man-pages. - --with-doxygen is removed: --disable-man-pages also disables doxygen unless --enable-html-doc is asserted. If html is requested, `make install` installs it in htmldir. Signed-off-by: Duncan Roe --- v2: broken out from 0001-build-doc-Fix-man-pages.patch v3: no change (still part of a series) v4: remove --without-doxygen since -disable-man-pages does that v5: - update .gitignore for clean `git status` after in-tree build - in configure.ac: - ensure all variables are always set (avoid leakage from environment) - provide helpful warning if HTML enabled but dot not found .gitignore | 5 ++++- configure.ac | 34 +++++++++++++++++++++++++++------- doxygen/Makefile.am | 11 ++++++++++- doxygen/doxygen.cfg.in | 3 ++- 4 files changed, 43 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 525628e..ae3e740 100644 --- a/.gitignore +++ b/.gitignore @@ -15,7 +15,10 @@ Makefile.in /libtool /stamp-h1 -/doxygen.cfg +/doxygen/doxygen.cfg /libnetfilter_queue.pc /examples/nf-queue +/doxygen/doxyfile.stamp +/doxygen/html/ +/doxygen/man/ diff --git a/configure.ac b/configure.ac index 4721eeb..83959b0 100644 --- a/configure.ac +++ b/configure.ac @@ -13,6 +13,22 @@ m4_ifdef([AM_PROG_AR], [AM_PROG_AR]) dnl kernel style compile messages m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) +AC_ARG_ENABLE([html-doc], + AS_HELP_STRING([--enable-html-doc], [Enable html documentation]), + [], [enable_html_doc=no]) +AM_CONDITIONAL([BUILD_HTML], [test "$enable_html_doc" = yes]) +AS_IF([test "$enable_html_doc" = yes], + [AC_SUBST(GEN_HTML, YES)], + [AC_SUBST(GEN_HTML, NO)]) + +AC_ARG_ENABLE([man-pages], + AS_HELP_STRING([--disable-man-pages], [Disable man page documentation]), + [], [enable_man_pages=yes]) +AM_CONDITIONAL([BUILD_MAN], [test "$enable_man_pages" = yes]) +AS_IF([test "$enable_man_pages" = yes], + [AC_SUBST(GEN_MAN, YES)], + [AC_SUBST(GEN_MAN, NO)]) + AC_PROG_CC AM_PROG_CC_C_O AC_DISABLE_STATIC @@ -36,12 +52,10 @@ AC_CONFIG_FILES([Makefile src/Makefile utils/Makefile examples/Makefile doxygen/Makefile doxygen/doxygen.cfg include/linux/Makefile include/linux/netfilter/Makefile]) -AC_ARG_WITH([doxygen], [AS_HELP_STRING([--with-doxygen], - [create doxygen documentation])], - [with_doxygen="$withval"], [with_doxygen=yes]) +AS_IF([test "$enable_man_pages" = no -a "$enable_html_doc" = no], [with_doxygen=no], [with_doxygen=yes]) AS_IF([test "x$with_doxygen" != xno], [ - AC_CHECK_PROGS([DOXYGEN], [doxygen]) + AC_CHECK_PROGS([DOXYGEN], [doxygen], [""]) AC_CHECK_PROGS([DOT], [dot], [""]) AS_IF([test "x$DOT" != "x"], [AC_SUBST(HAVE_DOT, YES)], @@ -52,12 +66,18 @@ AM_CONDITIONAL([HAVE_DOXYGEN], [test -n "$DOXYGEN"]) AS_IF([test "x$DOXYGEN" = x], [ AS_IF([test "x$with_doxygen" != xno], [ dnl Only run doxygen Makefile if doxygen installed - AC_MSG_WARN([Doxygen not found - continuing without Doxygen support]) - with_doxygen=no + AC_MSG_WARN([Doxygen not found - no documentation will be built]) + enable_html_doc=no + enable_man_pages=no ]) +], [ + dnl Warn user if html docs will be missing diagrams + AS_IF([test "$enable_html_doc" = yes -a -z "$DOT"], + AC_MSG_WARN([Dot not found - install graphviz to get interactive diagrams in HTML])) ]) AC_OUTPUT echo " libnetfilter_queue configuration: - doxygen: ${with_doxygen}" +man pages: ${enable_man_pages} +html docs: ${enable_html_doc}" diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am index 5a7fdd5..c6eeed7 100644 --- a/doxygen/Makefile.am +++ b/doxygen/Makefile.am @@ -14,7 +14,9 @@ doxyfile.stamp: $(doc_srcs) Makefile rm -rf html man doxygen doxygen.cfg >/dev/null +if BUILD_MAN $(abs_top_srcdir)/doxygen/build_man.sh +endif touch doxyfile.stamp @@ -24,13 +26,20 @@ all-local: doxyfile.stamp clean-local: rm -rf man html install-data-local: +if BUILD_MAN mkdir -p $(DESTDIR)$(mandir)/man3 cp --no-dereference --preserve=links,mode,timestamps man/man3/*.3\ $(DESTDIR)$(mandir)/man3/ +endif +if BUILD_HTML + mkdir -p $(DESTDIR)$(htmldir) + cp --no-dereference --preserve=links,mode,timestamps html/*\ + $(DESTDIR)$(htmldir) +endif # make distcheck needs uninstall-local uninstall-local: - rm -r $(DESTDIR)$(mandir) man html doxyfile.stamp + rm -rf $(DESTDIR)$(mandir) man html doxyfile.stamp $(DESTDIR)$(htmldir) endif EXTRA_DIST = build_man.sh diff --git a/doxygen/doxygen.cfg.in b/doxygen/doxygen.cfg.in index 99b5c90..14bd0cf 100644 --- a/doxygen/doxygen.cfg.in +++ b/doxygen/doxygen.cfg.in @@ -21,7 +21,8 @@ ALPHABETICAL_INDEX = NO SEARCHENGINE = NO GENERATE_LATEX = NO LATEX_CMD_NAME = latex -GENERATE_MAN = YES +GENERATE_MAN = @GEN_MAN@ +GENERATE_HTML = @GEN_HTML@ MAN_LINKS = YES HAVE_DOT = @HAVE_DOT@ DOT_TRANSPARENT = YES -- 2.17.5