summaryrefslogtreecommitdiffstats
path: root/doxygen
Commit message (Collapse)AuthorAgeFilesLines
* doc: move man-page sym-link shell-script into a separate fileJeremy Sowden2022-09-212-33/+43
| | | | | | | | We use `$(SHELL)` to run the script and exec bash if `$(SHELL)` is something else. We don't hard-code the path to bash. Signed-off-by: Jeremy Sowden <jeremy@azazel.net> Signed-off-by: Florian Westphal <fw@strlen.de>
* doc: move doxygen config file into doxygen directoryJeremy Sowden2022-09-213-1/+25
| | | | | | | | Now that the `INPUT` directory is correct, we can update `OUTPUT_DIRECTORY` to `.` and we don't need to cd out of the doxygen directory to run doxygen. Signed-off-by: Jeremy Sowden <jeremy@azazel.net> Signed-off-by: Florian Westphal <fw@strlen.de>
* doc: change `INPUT` doxygen setting to `@top_srcdir@`Jeremy Sowden2022-09-211-11/+0
| | | | | | | It avoids the need to move src directories in doxygen/Makefile. Signed-off-by: Jeremy Sowden <jeremy@azazel.net> Signed-off-by: Florian Westphal <fw@strlen.de>
* doc: add .gitignore for Doxygen artefactsJeremy Sowden2022-09-211-0/+3
| | | | | Signed-off-by: Jeremy Sowden <jeremy@azazel.net> Signed-off-by: Florian Westphal <fw@strlen.de>
* build: doc: refer to bash as bash, not /bin/bashMark Mentovai2022-09-211-1/+1
| | | | | | | | | | This locates bash according to its presence in the PATH, not at a hard-coded path which may not exist or may not be the most suitable bash to use. Signed-off-by: Mark Mentovai <mark@mentovai.com> Acked-by: Duncan Roe <duncan_roe@optusnet.com.au> Signed-off-by: Florian Westphal <fw@strlen.de>
* build: doc: get rid of the need for manual updating of MakefileDuncan Roe2021-08-011-40/+31
| | | | | | | | | | | | | | | | | There used to be 3 things in doxygen/Makefile.am that developers had to update: 1. The dependency list (i.e. all C sources) 2. The setgroup lines, which renamed each module man page to be the page for the first described function. setgroup also set the target for: 3. The add2group lines, which symlinked pages for other documented functions in the group. The new system eliminates all of the above. Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au> Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
* build: doc: "make" builds & installs a full set of man pagesDuncan Roe2021-06-231-0/+75
Repeat what we did for libnetfilter_queue: - New makefile in doxygen directory. Rebuilds documentation if any sources change that contain doxygen comments: - Renames each group man page to the first function listed therein - Creates symlinks for subsequently listed functions - Deletes _* temp files and moves sctruct-describing man pages to man7 - Update top-level makefile to visit new subdir doxygen - Update top-level configure to only build documentation if doxygen installed - Add --with/without-doxygen switch - Check whether dot is available when configuring doxygen - Reduce size of doxygen.cfg and doxygen build o/p - `make distcheck` passes with doxygen enabled Aditionally, exclude opaque structs mnl_nlmsg_batch & mnl_socket Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au> Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>