Re: [PATCH libnetfilter_queue v2] doc: make the HTML main page available as `man 7 libnetfilter_queue`

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Duncan,

On Thu, Sep 21, 2023 at 10:43:11AM +1000, Duncan Roe wrote:
> Without this patch, man page users can miss important general information.
> 
> The HTML display stays as it was.
> The man3 pages are updated to reference libnetfilter_queue.7.
> build_man.sh must be invoked with arguments to activate man7 generation,
> so will continue to work in other projects as before.
> build_man.sh remains generic,
> so should be able to make man7 pages for other netfilter projects.
> 
> v2: Change commit message from "how" to "why"
> 
> Signed-off-by: Duncan Roe <duncan_roe@xxxxxxxxxxxxxxx>
> ---
>  doxygen/Makefile.am      |   6 +--
>  doxygen/build_man.sh     | 101 +++++++++++++++++++++++++++++++++++++--
>  doxygen/man7.extra.txt   |   1 +
>  doxygen/old_doxy_fix.txt |   5 ++
>  src/libnetfilter_queue.c |  14 +++---
>  5 files changed, 113 insertions(+), 14 deletions(-)
>  create mode 100644 doxygen/man7.extra.txt
>  create mode 100644 doxygen/old_doxy_fix.txt
> 
> diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am
> index c6eeed7..e98368b 100644
> --- a/doxygen/Makefile.am
> +++ b/doxygen/Makefile.am
> @@ -10,12 +10,12 @@ doc_srcs = $(top_srcdir)/src/libnetfilter_queue.c\
>             $(top_srcdir)/src/extra/udp.c\
>             $(top_srcdir)/src/extra/icmp.c
>  
> -doxyfile.stamp: $(doc_srcs) Makefile
> +doxyfile.stamp: $(doc_srcs) Makefile build_man.sh man7.extra.txt old_doxy_fix.txt
>  	rm -rf html man
>  	doxygen doxygen.cfg >/dev/null
>  
>  if BUILD_MAN
> -	$(abs_top_srcdir)/doxygen/build_man.sh
> +	$(abs_top_srcdir)/doxygen/build_man.sh libnetfilter_queue libnetfilter_queue.c
>  endif
>  
>  	touch doxyfile.stamp
> @@ -42,4 +42,4 @@ uninstall-local:
>  	rm -rf $(DESTDIR)$(mandir) man html doxyfile.stamp $(DESTDIR)$(htmldir)
>  endif
>  
> -EXTRA_DIST = build_man.sh
> +EXTRA_DIST = build_man.sh man7.extra.txt old_doxy_fix.txt

Please, find a way to make this self-contained. We agreed to keep this
mangling to generate the API manpages and such in the build_man.sh
script, it will probably require more work on that front.

Thanks.



[Index of Archives]     [Netfitler Users]     [Berkeley Packet Filter]     [LARTC]     [Bugtraq]     [Yosemite Forum]

  Powered by Linux