if a line starts with a '.' (eg the '...' in qbarray.h) then
nroff thinks it's looking for a macro called '..'.
The easiest solution is to add a dummy format at the start of the line
(just adding \ seems not to work).
* doxygen2man: Add option to read copyright line from the header file
This should help make builds reproducible.
I tried various methods of getting the date, using 'git' is no use as
it could be run from a tarball, using the file date doesn't work either
so this seems a reasonable compromise.
* man: Use SOURCE_EPOCH to make manpage dates reproducible
Also add build-aux/update-copyright.sh to keep header file
copyright lines up-to-date.
All code taken from knet
* man: Use doxygen2man to make the API manpages
* [build] drop unused target
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
* [build] update gitignore
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
* [docs] make build -j safe and drop unnecessary dox config files
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
* man: Use doxygen2man to generate *.h.3 man pages
so we don't need to use the awful doxygen ones
Co-authored-by: Fabio M. Di Nitto <fdinitto@redhat.com>
doxygen2man: Lots of fixes and features
a) Make it quieter in normal operation
b) add options for hard coded things (like company name)
c) handle typedef members of structures
d) tidy function pointers in structs
e) get header file name from the XML or commandline
d) Add support for @ref tags in description
e) add support for @note annotations
f) Don't print (null) if there is no @brief description
g) Add include prefix option
h) use strncat rather than strcat
* doxygen2man: Add utility to generate man pages from doxygen
This is in here from kronosnet so it cna be used by other parts
of the cluster stack.
* [man] drop trailing white spaces
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
* [build] cleanup variable names
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
* [build] add conditionals to use internal or external doxygen2man
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
* Update .gitignore
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
Co-authored-by: Christine Caulfield <ccaulfie@redhat.com>
