diff options
| author | Duncan Roe <duncan_roe@optusnet.com.au> | 2020-02-08 12:28:44 +1100 |
|---|---|---|
| committer | Florian Westphal <fw@strlen.de> | 2020-02-24 00:27:16 +0100 |
| commit | caf166d8e6061a12ed531d5195396543d6f4dcee (patch) | |
| tree | bfb3c1d8d756894c3f9162aa82055f7e5ca41dfc /doxygen | |
| parent | 9d360e93cb2688f3fb8c37fd8e76e2a02e2d12bd (diff) | |
build: doc: "make" builds & installs a full set of man pages
This enables one to enter "man <any nfq function>" and get the appropriate
group man page created by doxygen.
- New makefile in doxygen directory. Rebuilds documentation if any sources
change that contain doxygen comments, or if fixmanpages.sh changes
- New shell script fixmanpages.sh which
- Renames each group man page to the first function listed therein
- Creates symlinks for subsequently listed functions (if any)
- Deletes _* temp files
- Update top-level makefile to visit new subdir doxygen
- Update top-level configure to only build documentation if doxygen installed
Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au>
Signed-off-by: Florian Westphal <fw@strlen.de>
Diffstat (limited to 'doxygen')
| -rw-r--r-- | doxygen/Makefile.am | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doxygen/Makefile.am b/doxygen/Makefile.am new file mode 100644 index 0000000..ef468e0 --- /dev/null +++ b/doxygen/Makefile.am @@ -0,0 +1,23 @@ +if HAVE_DOXYGEN +doc_srcs = $(top_srcdir)/src/libnetfilter_queue.c \ + $(top_srcdir)/src/nlmsg.c \ + $(top_srcdir)/src/extra/checksum.c \ + $(top_srcdir)/src/extra/ipv6.c \ + $(top_srcdir)/src/extra/ipv4.c \ + $(top_srcdir)/src/extra/tcp.c \ + $(top_srcdir)/src/extra/udp.c \ + $(top_srcdir)/src/extra/pktbuff.c + +doxyfile.stamp: $(doc_srcs) $(top_srcdir)/fixmanpages.sh + rm -rf html man && cd .. && doxygen doxygen.cfg && ./fixmanpages.sh + touch doxyfile.stamp + +CLEANFILES = doxyfile.stamp + +all-local: doxyfile.stamp +clean-local: + rm -rf $(top_srcdir)/doxygen/man $(top_srcdir)/doxygen/html +install-data-local: + mkdir -p $(DESTDIR)$(mandir)/man3 + cp --no-dereference --preserve=links,mode,timestamps man/man3/*.3 $(DESTDIR)$(mandir)/man3/ +endif |