From patchwork Sat Aug 28 03:35:03 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Duncan Roe X-Patchwork-Id: 1521831 X-Patchwork-Delegate: pablo@netfilter.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=netfilter-devel-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=MF/YnlW8; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4GxMfX41TCz9sWS for ; Sat, 28 Aug 2021 13:35:16 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233171AbhH1DgF (ORCPT ); Fri, 27 Aug 2021 23:36:05 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57522 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233101AbhH1DgE (ORCPT ); Fri, 27 Aug 2021 23:36:04 -0400 Received: from mail-pf1-x42e.google.com (mail-pf1-x42e.google.com [IPv6:2607:f8b0:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 34EE0C0613D9 for ; Fri, 27 Aug 2021 20:35:15 -0700 (PDT) Received: by mail-pf1-x42e.google.com with SMTP id s29so2525354pfw.5 for ; Fri, 27 Aug 2021 20:35:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=5VZBCyaq5mR8XSRgUCQBNhuB2c4wh1NWsb0wCIFvIuk=; b=MF/YnlW8s8na5/I52KD60+pJMKM28DhpHCkwP6iUAsbkTMrNNLuG29/MNzLujgV7St xrEsx+EsQV1AfQ4g5GS9kUXIb7i8RGrMNy2r46bIc9TXq6bQEm1yecqkvyU2kR4lKRdA EgmCpneTvuRskNsexdn3FymvETF9xMnMtCCuZ1sknYjJvQh2t7QuaQtRdSgeAbzs9WnU gLUvxSnjxf2bv42fLLVLLRYbF+Cd6/7j7gIjHDgOL/wzGIbDdQnTZ9w3I6ndzAoaty3Q llNu0gfAZ3NGOpDltYxA0N84hDA6c5Fpq7PB+xsPseANbWve4fPCcgbLVZT9kSM5O2LW oClA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :mime-version:content-transfer-encoding; bh=5VZBCyaq5mR8XSRgUCQBNhuB2c4wh1NWsb0wCIFvIuk=; b=BMhx/DDIC6KqlyIfsJUgX1zpEaktC4Ws3fPfGqZJZ0YrroZn/xoqsJgpFfe1vURTbH knwo6D6q9q24am81oUi3WKvnuftegHuMEjatoA4gdmXvjLhVBrkIe1XYTKvvtn8UrBI0 BzyrwpWSC5TBxo6mLx9Tt0rOUw6MA39G5v26TKaNIg4eda1nJ7KYGE/KOWInaq/H0uvq HreKGoegW99sgj7pB3EJY061+eeCHCei8Qut2R1SHIkzQehxS1T7xWfQnL2cSJVfTjwO H1AXUBbXMQU5oJxnC7Gctqy9mPTcIBINMB/qM3uWLv81nLa56+0P5w4zAmGf2GoOP+r8 cV5g== X-Gm-Message-State: AOAM532OotvM9Ma7Ksv3mha4U/ncqIYwHIiF9r+Bn2d3Wc6A4Cu67R2h 0RVLgD+zpMnhU5t0mMvjXvK2L47EkRk= X-Google-Smtp-Source: ABdhPJxb48+ikjJsq2W3JvqGQHpG98ksNn6xVEacMyy+yzsAI/9QZhXI3N/vqo49kjRfVBmPE3Nw0g== X-Received: by 2002:aa7:9096:0:b0:3e1:72fd:a614 with SMTP id i22-20020aa79096000000b003e172fda614mr11981026pfa.56.1630121714543; Fri, 27 Aug 2021 20:35:14 -0700 (PDT) Received: from slk1.local.net (n49-192-82-34.sun3.vic.optusnet.com.au. [49.192.82.34]) by smtp.gmail.com with ESMTPSA id q21sm8513021pgk.71.2021.08.27.20.35.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Aug 2021 20:35:14 -0700 (PDT) Sender: Duncan Roe From: Duncan Roe To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH libnetfilter_queue v3 1/6] build: doc: Fix man pages Date: Sat, 28 Aug 2021 13:35:03 +1000 Message-Id: <20210828033508.15618-1-duncan_roe@optusnet.com.au> X-Mailer: git-send-email 2.32.0 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netfilter-devel@vger.kernel.org Split off shell script from within doxygen/Makefile.am into doxygen/build_man.sh. This patch by itself doesn't fix anything. The patch is only for traceability, because diff patch format is not very good at catching code updates and moving code together. Therefore the script is exactly as it was; it still looks a bit different because of having to un-double doubled-up $ signs, remove trailing ";/" and so on. Signed-off-by: Duncan Roe --- doxygen/Makefile.am | 34 +++------------------------------- doxygen/build_man.sh | 29 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 31 deletions(-) create mode 100755 doxygen/build_man.sh diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am index 29078de..5068544 100644 --- a/doxygen/Makefile.am +++ b/doxygen/Makefile.am @@ -16,37 +16,7 @@ doxyfile.stamp: $(doc_srcs) Makefile.am [ ! -d ../src.distcheck ] || \ { set -x; cd ..; rm src; mv src.distcheck src; } -# We need to use bash for its associative array facility -# (`bash -p` prevents import of functions from the environment). -# The command has to be a single line so the functions work -# and so `make` gives all lines to `bash -c` -# (hence ";\" at the end of every line but the last). - /bin/bash -p -c 'declare -A renamed_page;\ -main(){ set -e; cd man/man3; rm -f _*;\ - count_real_pages;\ - rename_real_pages;\ - make_symlinks;\ -};\ -count_real_pages(){ page_count=0;\ - for i in $$(ls -S);\ - do head -n1 $$i | grep -E -q '^\.so' && break;\ - page_count=$$(($$page_count + 1));\ - done;\ - first_link=$$(($$page_count + 1));\ -};\ -rename_real_pages(){ for i in $$(ls -S | head -n$$page_count);\ - do for j in $$(ls -S | tail -n+$$first_link);\ - do grep -E -q $$i$$ $$j && break;\ - done;\ - mv -f $$i $$j;\ - renamed_page[$$i]=$$j;\ - done;\ -};\ -make_symlinks(){ for j in $$(ls -S | tail -n+$$first_link);\ - do ln -sf $${renamed_page[$$(cat $$j | cut -f2 -d/)]} $$j;\ - done;\ -};\ -main' + $(abs_top_srcdir)/doxygen/build_man.sh touch doxyfile.stamp @@ -64,3 +34,5 @@ install-data-local: uninstall-local: rm -r $(DESTDIR)$(mandir) man html doxyfile.stamp endif + +EXTRA_DIST = build_man.sh diff --git a/doxygen/build_man.sh b/doxygen/build_man.sh new file mode 100755 index 0000000..304a305 --- /dev/null +++ b/doxygen/build_man.sh @@ -0,0 +1,29 @@ +#!/bin/bash -p +# We need to use bash for its associative array facility +# (`bash -p` prevents import of functions from the environment). +declare -A renamed_page +main(){ set -e; cd man/man3; rm -f _* + count_real_pages + rename_real_pages + make_symlinks +} +count_real_pages(){ page_count=0 + for i in $(ls -S) + do head -n1 $i | grep -E -q '^\.so' && break + page_count=$(($page_count + 1)) + done + first_link=$(($page_count + 1)) +} +rename_real_pages(){ for i in $(ls -S | head -n$page_count) + do for j in $(ls -S | tail -n+$first_link) + do grep -E -q $i$ $j && break + done + mv -f $i $j + renamed_page[$i]=$j + done +} +make_symlinks(){ for j in $(ls -S | tail -n+$first_link) + do ln -sf ${renamed_page[$(cat $j | cut -f2 -d/)]} $j + done +} +main From patchwork Sat Aug 28 03:35:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Duncan Roe X-Patchwork-Id: 1521832 X-Patchwork-Delegate: pablo@netfilter.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=netfilter-devel-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=MK0F0tsZ; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4GxMfZ65Q1z9sWS for ; Sat, 28 Aug 2021 13:35:18 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233186AbhH1DgI (ORCPT ); Fri, 27 Aug 2021 23:36:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57532 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233101AbhH1DgH (ORCPT ); Fri, 27 Aug 2021 23:36:07 -0400 Received: from mail-pj1-x102f.google.com (mail-pj1-x102f.google.com [IPv6:2607:f8b0:4864:20::102f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 82734C0613D9 for ; Fri, 27 Aug 2021 20:35:17 -0700 (PDT) Received: by mail-pj1-x102f.google.com with SMTP id z24-20020a17090acb1800b0018e87a24300so6288582pjt.0 for ; Fri, 27 Aug 2021 20:35:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=onfLGWB8XWmbAy3oUNVY/ycjrD2iZZShg1CgFjokcKs=; b=MK0F0tsZmwYI+W6zkz6jAgcg88LAnvxrclMDvAuoglUPlptHvqsXTKYeSFqbmHrXGO W/vKj8M+m1Oka9Z1DBWOsE51ZLKkhxc9Tfrj1ONCUiuAjTe9jBDZpvx4FvdCW4RnIa+/ pCXbMiQK3HVlnSZ2D/VZHMLY5L5n+pKHR63ZPwPAdnErwsiDzo2ZhM3Pnwaji3AbAUsD F7LrLgO/q3XV6xVwoXBk1K9SlPkyJ4WvEEI2C2Cjxd7D1DoI202hTTutCUnqFhZ5VAJn XwNx7E2+jgFsiySGBkykIeN+Laix/PsKdVzn4XxjA/tN9DWYmP793kixw0W1OEaYGwmR 0akA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=onfLGWB8XWmbAy3oUNVY/ycjrD2iZZShg1CgFjokcKs=; b=aEE7x9L/xk+pApX2FkIGrc6NzyWEzBQOtf/Y26XIRDlg79UdDvW6cq1jvjs7dAR3TO caD4HYnuaE3cAj2rhFizA3LaYSQNtCA4sKcieVyXNFPN02sjo54mYGoLmjsoMvEWEVnC 1bFPQYAe01XVZYYo7lnwy6ZSUuBEp8hNz9VWdSsKBquPxHnAaSNbDoebI5SoDUzxTp5z k8MqnBW/jZhv/rEUFdkiAYxoFhxEsll3S1qzTUhTXLeQ0udoUjTmYJQaHikQN1VobTVK 3/WuLFmTD2IOWI/W6dK2QL1TiGcFr7f8NwGdphENZCctyXj72OrbRsGhOtgcejV38+nq J1YA== X-Gm-Message-State: AOAM531DYkw5ggmOwqqRA+tpMWk5b6y2szbuPf5rJEs79vdP8hScYxB2 Tb3EX8G4uWolSdBvj/ycSZ5lB29tYbY= X-Google-Smtp-Source: ABdhPJxvSxSQWDnjLph7rpJ+TWIp/1KUK+Yo6WjvlPQmff0a/NGziLh/rGxaLX9HUZPRbWKBkJRwjw== X-Received: by 2002:a17:902:c643:b0:138:b603:f940 with SMTP id s3-20020a170902c64300b00138b603f940mr199556pls.71.1630121717047; Fri, 27 Aug 2021 20:35:17 -0700 (PDT) Received: from slk1.local.net (n49-192-82-34.sun3.vic.optusnet.com.au. [49.192.82.34]) by smtp.gmail.com with ESMTPSA id q21sm8513021pgk.71.2021.08.27.20.35.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Aug 2021 20:35:16 -0700 (PDT) Sender: Duncan Roe From: Duncan Roe To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH libnetfilter_queue v3 2/6] build: doc: Add a man page post-processor to build_man.sh Date: Sat, 28 Aug 2021 13:35:04 +1000 Message-Id: <20210828033508.15618-2-duncan_roe@optusnet.com.au> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210828033508.15618-1-duncan_roe@optusnet.com.au> References: <20210828033508.15618-1-duncan_roe@optusnet.com.au> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netfilter-devel@vger.kernel.org - If there is a "Modules" section, delete it - If "Detailed Description" is empty, delete "Detailed Description" line - Reposition SYNOPSIS (with headers that we inserted) to start of page, integrating with defined functions to look like other man pages - Delete all "Definition at line nnn" lines - Delete lines that make older versions of man o/p an unwanted blank line For better readability, shell function definitions are separated by blank lines, and there is a bit of annotation. Signed-off-by: Duncan Roe --- doxygen/build_man.sh | 200 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 195 insertions(+), 5 deletions(-) diff --git a/doxygen/build_man.sh b/doxygen/build_man.sh index 304a305..e0cda71 100755 --- a/doxygen/build_man.sh +++ b/doxygen/build_man.sh @@ -1,20 +1,37 @@ #!/bin/bash -p -# We need to use bash for its associative array facility + +# Script to process man pages output by doxygen. +# We need to use bash for its associative array facility. # (`bash -p` prevents import of functions from the environment). + declare -A renamed_page -main(){ set -e; cd man/man3; rm -f _* + +main(){ + set -e + cd man/man3; rm -f _* count_real_pages rename_real_pages make_symlinks + post_process } -count_real_pages(){ page_count=0 + +count_real_pages(){ + page_count=0 + # + # Count "real" man pages (i.e. not generated by MAN_LINKS) + # MAN_LINKS pages are 1-liners starting .so + # Method: list files in descending order of size, + # looking for the first 1-liner + # for i in $(ls -S) do head -n1 $i | grep -E -q '^\.so' && break page_count=$(($page_count + 1)) done first_link=$(($page_count + 1)) } -rename_real_pages(){ for i in $(ls -S | head -n$page_count) + +rename_real_pages(){ + for i in $(ls -S | head -n$page_count) do for j in $(ls -S | tail -n+$first_link) do grep -E -q $i$ $j && break done @@ -22,8 +39,181 @@ rename_real_pages(){ for i in $(ls -S | head -n$page_count) renamed_page[$i]=$j done } -make_symlinks(){ for j in $(ls -S | tail -n+$first_link) + +make_symlinks(){ + for j in $(ls -S | tail -n+$first_link) do ln -sf ${renamed_page[$(cat $j | cut -f2 -d/)]} $j done } + +post_process(){ + make_temp_files + # + # DIAGNOSTIC / DEVELOPMENT CODE + # set -x and restrict processing to keep_me: un-comment to activate + # Change keep_me as required + # + #keep_me=nfq_icmp_get_hdr.3;\ + #do_diagnostics;\ + # + # Work through the "real" man pages + for target in $(ls -S | head -n$page_count) + do mygrep "^\\.SH \"Function Documentation" $target + # Next file if this isn't a function page + [ $linnum -ne 0 ] || continue + + del_modules + del_bogus_synopsis + fix_name_line + move_synopsis + del_empty_det_desc + del_def_at_lines + fix_double_blanks + done + + remove_temp_files +} + +fix_double_blanks(){ + linnum=1 + # + # Older versions of man display a blank line on encountering "\fB\fP"; + # newer versions of man do not. + # doxygen emits "\fB\fP" on seeing "\par" on a line by itself. + # "\par" gives us double-spacing in the web doc, which we want, but double- + # spacing looks odd in a man page so remove "\fB\fP". + # + while [ $linnum -ne 0 ] + do mygrep \\\\fB\\\\fP $target + [ $linnum -eq 0 ] || delete_lines $linnum $linnum + done +} + +del_def_at_lines(){ + linnum=1 + while [ $linnum -ne 0 ] + do mygrep "^Definition at line [[:digit:]]* of file" $target + [ $linnum -eq 0 ] || delete_lines $(($linnum - 1)) $linnum + done +} + +# Only invoked if you un-comment the 2 diagnostic / development lines above +do_diagnostics(){ + mv $keep_me xxx + rm *.3 + mv xxx $keep_me + page_count=1 + set -x +} + +del_empty_det_desc(){ + mygrep "^\\.SH \"Function Documentation" $target + i=$linnum + mygrep "^\\.SH \"Detailed Description" $target + [ $linnum -ne 0 ] || return 0 + [ $(($i - $linnum)) -eq 3 ] || return 0 + delete_lines $linnum $(($i -1)) +} + +move_synopsis(){ + mygrep "SH SYNOPSIS" $target + [ $linnum -ne 0 ] || return 0 + i=$linnum + # If this is a doxygen-created synopsis, leave it. + # (We haven't inserted our own one in the source yet) + mygrep "^\\.SS \"Functions" $target + [ $i -gt $linnum ] || return 0 + + mygrep "^\\.SH \"Function Documentation" $target + j=$(($linnum - 1)) + head -n$(($j - 1)) $target | tail -n$(($linnum - $i - 1)) >$fileC + delete_lines $i $j + mygrep "^\\.SS \"Functions" $target + head -n$(($linnum - 1)) $target >$fileA + tail -n+$(($linnum + 1)) $target >$fileB + cat $fileA $fileC $fileB >$target +} + +fix_name_line(){ + all_funcs="" + + # Search a shortened version of the page in case there are .RI lines later + mygrep "^\\.SH \"Function Documentation" $target + head -n$linnum $target >$fileC + + while : + do mygrep ^\\.RI $fileC + [ $linnum -ne 0 ] || break + # Discard this entry + tail -n+$(($linnum + 1)) $fileC >$fileB + cp $fileB $fileC + + func=$(cat $fileG | cut -f2 -d\\ | cut -c3-) + [ -z "$all_funcs" ] && all_funcs=$func ||\ + all_funcs="$all_funcs, $func" + done + # For now, assume name is at line 5 + head -n4 $target >$fileA + desc=$(head -n5 $target | tail -n1 | cut -f3- -d" ") + tail -n+6 $target >$fileB + cat $fileA >$target + echo "$all_funcs \\- $desc" >>$target + cat $fileB >>$target +} + +del_modules(){ + mygrep "^\.SS \"Modules" $target + [ $linnum -ne 0 ] || return 0 + i=$linnum + mygrep "^\\.SS \"Functions" $target + delete_lines $i $(($linnum - 1)) +} + +del_bogus_synopsis(){ + mygrep "SH SYNOPSIS" $target + # + # doxygen 1.8.20 inserts its own SYNOPSIS line but there is no mention + # in the documentation or git log what to do with it. + # So get rid of it + # + [ $linnum -ne 0 ] || return 0 + i=$linnum + # Look for the next one + tail -n+$(($i + 1)) $target >$fileC;\ + mygrep "SH SYNOPSIS" $fileC + [ $linnum -ne 0 ] || return 0 + + mygrep "^\\.SS \"Functions" $target + delete_lines $i $(($linnum - 1)) +} + +# Delete lines $1 through $2 from $target +delete_lines(){ + head -n$(($1 - 1)) $target >$fileA + tail -n+$(($2 +1)) $target >$fileB + cat $fileA $fileB >$target +} + +mygrep(){ + set +e + grep -En "$1" $2 2>/dev/null >$fileH + [ $? -ne 0 ] && linnum=0 ||\ + { head -n1 $fileH >$fileG; linnum=$(cat $fileG | cut -f1 -d:); } + set -e +} + +make_temp_files(){ + temps="A B C G H" + for i in $temps + do declare -g file$i=$(mktemp) + done +} + +remove_temp_files(){ + for i in $temps + do j=file$i + rm ${!j} + done +} + main From patchwork Sat Aug 28 03:35:05 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Duncan Roe X-Patchwork-Id: 1521833 X-Patchwork-Delegate: pablo@netfilter.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=netfilter-devel-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=mQzI8h8u; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4GxMfd5zhPz9sWS for ; Sat, 28 Aug 2021 13:35:21 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233194AbhH1DgL (ORCPT ); Fri, 27 Aug 2021 23:36:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57540 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233101AbhH1DgK (ORCPT ); Fri, 27 Aug 2021 23:36:10 -0400 Received: from mail-pl1-x62a.google.com (mail-pl1-x62a.google.com [IPv6:2607:f8b0:4864:20::62a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DFC87C0613D9 for ; Fri, 27 Aug 2021 20:35:19 -0700 (PDT) Received: by mail-pl1-x62a.google.com with SMTP id j2so5239022pll.1 for ; Fri, 27 Aug 2021 20:35:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=h7JSeVcstpv4YiH7xcHTuZOX1UO+JywwOv2W9h51WD0=; b=mQzI8h8u+A5k18s9q3BB0Ot4VozzgGPkrIvUjYraO3ChBWv/iHoqbErmJ2bZSFqvhg uPE7H3akKuaKfQ8aIcKaVSyJgu/WZer9c23bpIbQ3GHCeccUsczbOGG1xqsPR1OQJu1Q fJb9klKk1Gcdy9NdjNlWSGWH4Tr+Y2TBNeBMpsGKubJ8RbNj6Z9qg6cd35j7MeJ1tUNT v/80Zvzt5kfMd7YvY9F6NiCklP5xG3ldvgVtbU9YYNO6TArq20XYTscyjLwafzYajt5W Sfex0aN9yPwiV8O6cZw9BxNjfkbJUtZ0OunvZFReZX4Way3Qx2fCW5rx75p1SEht4Wku GYNQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=h7JSeVcstpv4YiH7xcHTuZOX1UO+JywwOv2W9h51WD0=; b=mf9CW9sYFEXe8FHFfV4eFdh6S8NzbXTUoG4J6KdYCvz1JHx+kBOixOBIeYdYu1pu4L yVGp0vL/v4oyCHO6XwjS4wli+W0jaeJlua/Kf18muT1spk+cW8fY9vG9eqEXjgYJO/H9 jNXCL+X5iEvZSsz+jQ5rU9dXF4GaoaD68IoAOYKn81eksTyBIaf1MRCg4yjpFQRxnZiu ZY5VpNdY4xYusZcojCcmDTRKrZBRTEqmbEHQXS+7bPIStTvEhh9WWCSh28wHKUMUT/rt m/9RGFh+GvhipA4D2IRvM/miKbt5bXIZW9arVguS6emqCJZeyfszAIWstkose30k7HGn /ifA== X-Gm-Message-State: AOAM531Df4V1ZWDkESJ+qaO849W9t5WL/PAtxT1us78TDiflDpTgzwAu n1/qzoUUnvTZ5/GWhVfp+WYLLjx7hao= X-Google-Smtp-Source: ABdhPJziOR12NhwIeTtjzSAIzo+SZG7zoGIXMSiPWkUJnf0cCRZGXwMF1NbF7yiweI0de3ZlUUcATA== X-Received: by 2002:a17:902:6b09:b029:129:c61e:e31a with SMTP id o9-20020a1709026b09b0290129c61ee31amr11448750plk.57.1630121719460; Fri, 27 Aug 2021 20:35:19 -0700 (PDT) Received: from slk1.local.net (n49-192-82-34.sun3.vic.optusnet.com.au. [49.192.82.34]) by smtp.gmail.com with ESMTPSA id q21sm8513021pgk.71.2021.08.27.20.35.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Aug 2021 20:35:19 -0700 (PDT) Sender: Duncan Roe From: Duncan Roe To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH libnetfilter_queue v3 3/6] build: doc: Avoid having to special-case `make distcheck` Date: Sat, 28 Aug 2021 13:35:05 +1000 Message-Id: <20210828033508.15618-3-duncan_roe@optusnet.com.au> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210828033508.15618-1-duncan_roe@optusnet.com.au> References: <20210828033508.15618-1-duncan_roe@optusnet.com.au> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netfilter-devel@vger.kernel.org - Move doxygen.cfg.in to doxygen/ - Tell doxygen.cfg.in where the sources are - Let doxygen.cfg.in default its output to CWD - In Makefile, `doxygen doxygen.cfg` "just works" Signed-off-by: Duncan Roe --- configure.ac | 4 ++-- doxygen/Makefile.am | 12 +----------- doxygen.cfg.in => doxygen/doxygen.cfg.in | 3 +-- 3 files changed, 4 insertions(+), 15 deletions(-) rename doxygen.cfg.in => doxygen/doxygen.cfg.in (93%) diff --git a/configure.ac b/configure.ac index 0fe754c..4721eeb 100644 --- a/configure.ac +++ b/configure.ac @@ -31,9 +31,9 @@ PKG_CHECK_MODULES([LIBMNL], [libmnl >= 1.0.3]) dnl Output the makefiles AC_CONFIG_FILES([Makefile src/Makefile utils/Makefile examples/Makefile - libnetfilter_queue.pc doxygen.cfg + libnetfilter_queue.pc include/Makefile include/libnetfilter_queue/Makefile - doxygen/Makefile + doxygen/Makefile doxygen/doxygen.cfg include/linux/Makefile include/linux/netfilter/Makefile]) AC_ARG_WITH([doxygen], [AS_HELP_STRING([--with-doxygen], diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am index 5068544..f38009b 100644 --- a/doxygen/Makefile.am +++ b/doxygen/Makefile.am @@ -4,17 +4,7 @@ doc_srcs = $(shell find $(top_srcdir)/src -name '*.c') doxyfile.stamp: $(doc_srcs) Makefile.am rm -rf html man - -# Test for running under make distcheck. -# If so, sibling src directory will be empty: -# move it out of the way and symlink the real one while we run doxygen. - [ -f ../src/Makefile.in ] || \ -{ set -x; cd ..; mv src src.distcheck; ln -s $(top_srcdir)/src; } - - cd ..; doxygen doxygen.cfg >/dev/null - - [ ! -d ../src.distcheck ] || \ -{ set -x; cd ..; rm src; mv src.distcheck src; } + doxygen doxygen.cfg >/dev/null $(abs_top_srcdir)/doxygen/build_man.sh diff --git a/doxygen.cfg.in b/doxygen/doxygen.cfg.in similarity index 93% rename from doxygen.cfg.in rename to doxygen/doxygen.cfg.in index 266782e..99b5c90 100644 --- a/doxygen.cfg.in +++ b/doxygen/doxygen.cfg.in @@ -1,12 +1,11 @@ # Difference with default Doxyfile 1.8.20 PROJECT_NAME = @PACKAGE@ PROJECT_NUMBER = @VERSION@ -OUTPUT_DIRECTORY = doxygen ABBREVIATE_BRIEF = FULL_PATH_NAMES = NO TAB_SIZE = 8 OPTIMIZE_OUTPUT_FOR_C = YES -INPUT = . +INPUT = @abs_top_srcdir@/src FILE_PATTERNS = *.c RECURSIVE = YES EXCLUDE_SYMBOLS = EXPORT_SYMBOL \ From patchwork Sat Aug 28 03:35:06 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Duncan Roe X-Patchwork-Id: 1521834 X-Patchwork-Delegate: pablo@netfilter.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=netfilter-devel-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=R2AkFG7I; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4GxMfg4CWKz9sWS for ; Sat, 28 Aug 2021 13:35:23 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233202AbhH1DgM (ORCPT ); Fri, 27 Aug 2021 23:36:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57552 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233101AbhH1DgM (ORCPT ); Fri, 27 Aug 2021 23:36:12 -0400 Received: from mail-pl1-x634.google.com (mail-pl1-x634.google.com [IPv6:2607:f8b0:4864:20::634]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6ABCDC0613D9 for ; Fri, 27 Aug 2021 20:35:22 -0700 (PDT) Received: by mail-pl1-x634.google.com with SMTP id m4so5265707pll.0 for ; Fri, 27 Aug 2021 20:35:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=v/Hvz2y/9yGlffyGt+XTnmqXlX/CDQpwKYs2JIVv1H8=; b=R2AkFG7IWV3v2SN2WuteQxlIPC/zQD85rnqEMG3fzPFK21PDbyhCQrqtNS/bwQrbmb izq9BE9Dnoa7xbEeCZM//+r94dXQigv4Vjp2CZJE4Dk0zrbmRqGJ8sUUcNXEueu5a8BN CG0VBFV/UPqlmV/aX64IXjE+EYMtLJiCXq5d3Pi4ERV5BK+/gRiAWatDK0kcXcOc7ujY amonRdnbRK2DoSDfS5LFkTKoVabuzomaL9sUfBRs1wLYEPEvXgl4l68MJY9uYWdcNu5q 4TAqu8XhC0y+wy3TeDzD+0oAX/FVAru+38BIrHFir4EGgdHeDexpnLlZcfnaZ6ek7QjW SjiA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=v/Hvz2y/9yGlffyGt+XTnmqXlX/CDQpwKYs2JIVv1H8=; b=gbt4Ky5vyYqPT7vY9g7L2PWt1q6Ts/BY3fSLnNXveurwWb+erpnfRlJh5LeaTcsFUo ez/t4bPzX5F6qX7sSigM6erzlBcZTLOYYMEfjncR75viNPAtMCvOHckg/xsbIuJeM15W zeagqFKDCvxH9hsqkeAX6HbIqUamFVS45D3tba6qq4MdiYFgUOczb+jS6LLRlYDXDPth QGMrinxfYnmjlYUGJ5gOmxr6LJO96kddHAF9YDmKE46hi14xioHSHb6pQNeIBz9X1gYY 0bbxVtx1L910ppwIaVK0x7QNYtjImKoQn5MZ8968F6yv7gPIqu0J9aYEs9r6RiAcJZ6i OFjg== X-Gm-Message-State: AOAM531FxKuHGBmOZkC5RusVPYKqGew0F9AJNEIEMYDHt+wNwgKs3Nf7 3c+7RUd6kQ+cARFjdSNTgBQ= X-Google-Smtp-Source: ABdhPJzYm9CAaFeos4paHLnIEBJjzP0N6lFBhWeD29y08M2eZ2RJuv+vTS9dSOfm4bCzt3gMw/m9kg== X-Received: by 2002:a17:902:ec92:b0:135:772b:89b3 with SMTP id x18-20020a170902ec9200b00135772b89b3mr11669981plg.74.1630121721972; Fri, 27 Aug 2021 20:35:21 -0700 (PDT) Received: from slk1.local.net (n49-192-82-34.sun3.vic.optusnet.com.au. [49.192.82.34]) by smtp.gmail.com with ESMTPSA id q21sm8513021pgk.71.2021.08.27.20.35.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Aug 2021 20:35:21 -0700 (PDT) Sender: Duncan Roe From: Duncan Roe To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH libnetfilter_queue v3 4/6] build: doc: fix `make distcleancheck` Date: Sat, 28 Aug 2021 13:35:06 +1000 Message-Id: <20210828033508.15618-4-duncan_roe@optusnet.com.au> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210828033508.15618-1-duncan_roe@optusnet.com.au> References: <20210828033508.15618-1-duncan_roe@optusnet.com.au> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netfilter-devel@vger.kernel.org `make distcleancheck` was not passing before this patchset. Now fixed. Signed-off-by: Duncan Roe --- doxygen/Makefile.am | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am index f38009b..bab34bf 100644 --- a/doxygen/Makefile.am +++ b/doxygen/Makefile.am @@ -14,7 +14,7 @@ CLEANFILES = doxyfile.stamp all-local: doxyfile.stamp clean-local: - rm -rf $(top_srcdir)/doxygen/man $(top_srcdir)/doxygen/html + rm -rf man html install-data-local: mkdir -p $(DESTDIR)$(mandir)/man3 cp --no-dereference --preserve=links,mode,timestamps man/man3/*.3\ From patchwork Sat Aug 28 03:35:07 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Duncan Roe X-Patchwork-Id: 1521835 X-Patchwork-Delegate: pablo@netfilter.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=netfilter-devel-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=pDIQIVuQ; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4GxMfn4mBtz9sWS for ; Sat, 28 Aug 2021 13:35:29 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233214AbhH1DgS (ORCPT ); Fri, 27 Aug 2021 23:36:18 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57566 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233101AbhH1DgP (ORCPT ); Fri, 27 Aug 2021 23:36:15 -0400 Received: from mail-pl1-x62b.google.com (mail-pl1-x62b.google.com [IPv6:2607:f8b0:4864:20::62b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E72EBC0613D9 for ; Fri, 27 Aug 2021 20:35:24 -0700 (PDT) Received: by mail-pl1-x62b.google.com with SMTP id e15so5219587plh.8 for ; Fri, 27 Aug 2021 20:35:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=U0sGQZisqo/d8DbrnRxT6BJu0mjRO69QFmL09EvxPKw=; b=pDIQIVuQS/Hb6ZiWl1eC80qwZoT/N8zLQ/8YT4yk311yQGAQJDFF8XvBfFQWn1fIVN ZUtFUOgn6gDEaHyWNJOGZ9r/adj83Mhf787xzii1mPk/Z53mQHrGOGBLij/hvU8mI/cR QQ036zuCchH8cQl/MkcQqKZWhG3d7TTzrA6v1zG5yR+4wO31TMnbL5HK3VNplADpZKGs 7nMqu4DSaKCjaYdKwm2PZ+QAYIYNVxQDSU6K89TT5R1PEbEBkzS510ltYU81ojwWZt4Y 1M46Ak9c8w0TbKlnU+3mbj5vOZf0Td1YGjGTViTioeN9ROk0pipPS8HkcfnpQG4Gdxq4 icUA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=U0sGQZisqo/d8DbrnRxT6BJu0mjRO69QFmL09EvxPKw=; b=KrO2X5uaJDtOjvJVnvy4x+WTnClswgI2q6CKh7y8xpwDs5xGUOfYeoqijbaDAriUyy TY+B3jrbxp8vJ87Dbjnko1ILVxcOndDX9C21e3ybROUm/BF3e1viJ/moAsi0QIUzhmT3 5hZVssTjNEWgw0vE8waS48OEQTwSfxLrQfU1/j6+NdCPQ/1ZoAmKJE6iiIgLwrVTEQph 5YZ9VmmT4XlUQoB8cpm06ksz9pTTY1GtvejQ+XGo+bj7BtXlOySUJDxjGo4xdjmyvn1O DASPtKPD6Fhayv9HX298ehkwWwPWpZ1mrOTRvRjIm+uIWJ4TXjvAaT5VlfTd+4T/IKAQ HcuQ== X-Gm-Message-State: AOAM532VbvvJnFxOswljP8Wb16/1Nh8SmejxIgrey4awXlq6Sh6LPiED +b/rjfz0s69hugeMc8YORshe88kdCrs= X-Google-Smtp-Source: ABdhPJy//k3DqImJxyv8HoTho94+PW5G8cxpSbDDLt1cvpajt0CgLSEx14FC6Yq9IN2MUsAQPbchOA== X-Received: by 2002:a17:902:b10b:b0:134:de66:4f8c with SMTP id q11-20020a170902b10b00b00134de664f8cmr11697752plr.66.1630121724429; Fri, 27 Aug 2021 20:35:24 -0700 (PDT) Received: from slk1.local.net (n49-192-82-34.sun3.vic.optusnet.com.au. [49.192.82.34]) by smtp.gmail.com with ESMTPSA id q21sm8513021pgk.71.2021.08.27.20.35.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Aug 2021 20:35:23 -0700 (PDT) Sender: Duncan Roe From: Duncan Roe To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH libnetfilter_queue v3 5/6] build: doc: Allow to specify whether to produce man pages, html, neither or both Date: Sat, 28 Aug 2021 13:35:07 +1000 Message-Id: <20210828033508.15618-5-duncan_roe@optusnet.com.au> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210828033508.15618-1-duncan_roe@optusnet.com.au> References: <20210828033508.15618-1-duncan_roe@optusnet.com.au> MIME-Version: 1.0 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 --without-doxygen, --enable-html-doc & --disable-man-pages. - configure warns on inconsistent options e.g. --without-doxygen by itself warns man pages will not be built. - configure.ac re-ordered so --without-doxygen overrides --enable-any-doc. If html is requested, `make install` installs it in htmldir. Signed-off-by: Duncan Roe --- configure.ac | 41 ++++++++++++++++++++++++++++++++++++----- doxygen/Makefile.am | 11 ++++++++++- doxygen/doxygen.cfg.in | 3 ++- 3 files changed, 48 insertions(+), 7 deletions(-) diff --git a/configure.ac b/configure.ac index 4721eeb..a4fb629 100644 --- a/configure.ac +++ b/configure.ac @@ -13,6 +13,35 @@ m4_ifdef([AM_PROG_AR], [AM_PROG_AR]) dnl kernel style compile messages m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) +dnl Must check for --without-doxygen before checking --enable-* +AC_ARG_WITH([doxygen], [AS_HELP_STRING([--without-doxygen], + [Don't run doxygen (to create documentation)])], + [with_doxygen="$withval"], [with_doxygen=yes]) + +AC_ARG_ENABLE([html-doc], + AS_HELP_STRING([--enable-html-doc], [Enable html documentation]), + [], [enable_html_doc=no]) +AS_IF([test "$with_doxygen" = no -a "$enable_html_doc" = yes], [ + AC_MSG_WARN([Doxygen disabled - html documentation will not be built]) + 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]) +AS_IF([test "$with_doxygen" = no -a "$enable_man_pages" = yes], [ + AC_MSG_WARN([Doxygen disabled - man pages will not be built]) + enable_man_pages=no +]) +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,9 +65,7 @@ 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]) AS_IF([test "x$with_doxygen" != xno], [ AC_CHECK_PROGS([DOXYGEN], [doxygen]) @@ -52,12 +79,16 @@ 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]) + AC_MSG_WARN([Doxygen not found - no documentation will be built]) with_doxygen=no + enable_html_doc=no + enable_man_pages=no ]) ]) AC_OUTPUT echo " libnetfilter_queue configuration: - doxygen: ${with_doxygen}" + doxygen: ${with_doxygen} +man pages: ${enable_man_pages} +html docs: ${enable_html_doc}" diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am index bab34bf..5235f78 100644 --- a/doxygen/Makefile.am +++ b/doxygen/Makefile.am @@ -6,7 +6,9 @@ doxyfile.stamp: $(doc_srcs) Makefile.am rm -rf html man doxygen doxygen.cfg >/dev/null +if BUILD_MAN $(abs_top_srcdir)/doxygen/build_man.sh +endif touch doxyfile.stamp @@ -16,13 +18,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 From patchwork Sat Aug 28 03:35:08 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Duncan Roe X-Patchwork-Id: 1521836 X-Patchwork-Delegate: pablo@netfilter.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=netfilter-devel-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20161025 header.b=rSFrcvf1; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4GxMfp0kfLz9sWd for ; Sat, 28 Aug 2021 13:35:30 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233222AbhH1DgT (ORCPT ); Fri, 27 Aug 2021 23:36:19 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57576 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233209AbhH1DgR (ORCPT ); Fri, 27 Aug 2021 23:36:17 -0400 Received: from mail-pj1-x102c.google.com (mail-pj1-x102c.google.com [IPv6:2607:f8b0:4864:20::102c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2008CC061796 for ; Fri, 27 Aug 2021 20:35:27 -0700 (PDT) Received: by mail-pj1-x102c.google.com with SMTP id g13-20020a17090a3c8d00b00196286963b9so3211379pjc.3 for ; Fri, 27 Aug 2021 20:35:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=mBb9vweGqolgGOloEEaVpVK8Jo1hYhpptbrlcwsSipk=; b=rSFrcvf13v86N133ZFdk9/sRkkdH9hPsEYvEMt1bgcqVOGXd0mlP0JbRMyTvhPzpRO emOY+KOSETZRz+NNXuRFUcaB2fY5RSJIppO5WuUyPEzLmxsfR2lj3VD5jaN+HVNiS04k LpVt4sYLszEcwvBBFbmV1Biuu4PhDLAlzsoxOthfVr1DDqM4tM/MJXKFyLc/rSz2F0Gl 7o4XtmdtNTO9DO8LQ2bWBP4B9su+tPJ4gfiqCgsf3e6v6f0EvSwIV/Ryv7rkxzyaPkpq sbAkKsXK5AbSWWOIbhWy6KnJIxR9paK03CLzE2Uq4syjmN9Db5P6eg5joCvZA+OJFTgf xVcg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=mBb9vweGqolgGOloEEaVpVK8Jo1hYhpptbrlcwsSipk=; b=dPW90OUOUmtLCZ80CE4pVQd+gcSc2pJzhPA5IQ0xUnff+ngJZMNgxgvo43CKLMxbam ULDTdQdDm7sbTsstkcCD/I8elsUCtsKzkEQ2f5BUNz35/2fZJwEHEHIZQshDL/ZjOBh3 lJ/CTgWVZDbFqXyTQgn8tS7oEQGng3+kmg3V0f5SzwJwZANcDIcVTKJXFosonLLgZBpe rgKYIJrp/L4nzUJlJWHKRLerPJG9kvLbX8NcIYYIF8zFi/WWw2WWKPrSx+f1+CeNTzyN fSbCiODZW796Bw49bc4Uk+Cwm06XTa1Dar/koOZPR9SJAWskV9gUctPjY+CoVp7BIYgl t3lg== X-Gm-Message-State: AOAM533F2WNz0RgMxQWEKOV8JaRVOwkYeVHSam/IM+igTE2GJYrOtDRb Zb4DFmpcDkMnV0mab7ZUuP4= X-Google-Smtp-Source: ABdhPJy0CL9cyid18NB1XKVTmY0b/fTU8X4lvrujSAu7mm6WkugDrJ0J8mFfYDVKWZcDsIYOLWG9Ag== X-Received: by 2002:a17:90a:8549:: with SMTP id a9mr25861638pjw.98.1630121726742; Fri, 27 Aug 2021 20:35:26 -0700 (PDT) Received: from slk1.local.net (n49-192-82-34.sun3.vic.optusnet.com.au. [49.192.82.34]) by smtp.gmail.com with ESMTPSA id q21sm8513021pgk.71.2021.08.27.20.35.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Aug 2021 20:35:26 -0700 (PDT) Sender: Duncan Roe From: Duncan Roe To: pablo@netfilter.org Cc: netfilter-devel@vger.kernel.org Subject: [PATCH libnetfilter_queue v3 6/6] build: doc: Eliminate warning from ./autogen.sh Date: Sat, 28 Aug 2021 13:35:08 +1000 Message-Id: <20210828033508.15618-6-duncan_roe@optusnet.com.au> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210828033508.15618-1-duncan_roe@optusnet.com.au> References: <20210828033508.15618-1-duncan_roe@optusnet.com.au> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netfilter-devel@vger.kernel.org Running autogen.sh gives the following output when it gets to doxygen/Makefile.am: doxygen/Makefile.am:3: warning: shell find $(top_srcdir: non-POSIX variable name doxygen/Makefile.am:3: (probably a GNU make extension) Since we are targetting GNU make, disable such warnings. suggested_by: Jeremy Sowden Signed-off-by: Duncan Roe --- configure.ac | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/configure.ac b/configure.ac index a4fb629..cdd333a 100644 --- a/configure.ac +++ b/configure.ac @@ -6,7 +6,7 @@ AC_CANONICAL_HOST AC_CONFIG_MACRO_DIR([m4]) AC_CONFIG_HEADERS([config.h]) -AM_INIT_AUTOMAKE([-Wall foreign subdir-objects +AM_INIT_AUTOMAKE([-Wall -Wno-portability foreign subdir-objects tar-pax no-dist-gzip dist-bzip2 1.6]) m4_ifdef([AM_PROG_AR], [AM_PROG_AR])