From 41be44cc940f3c9e14929cbcb3d1a546fa66795d Mon Sep 17 00:00:00 2001 From: nirenjan Date: Mon, 11 Oct 2021 09:54:27 -0700 Subject: [PATCH] Add documentation for x52bugreport --- Makefile.am | 2 +- bugreport/Makefile.am | 2 ++ bugreport/bugreport.dox | 22 ++++++++++++++++++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 bugreport/bugreport.dox diff --git a/Makefile.am b/Makefile.am index 532cfca..2b1f3ca 100644 --- a/Makefile.am +++ b/Makefile.am @@ -62,7 +62,7 @@ all-local: docs/.stamp clean-local: rm -rf $(top_builddir)/docs -man1_MANS = docs/man/man1/x52cli.1 +man1_MANS = docs/man/man1/x52cli.1 docs/man/man1/x52bugreport.1 $(man1_MANS): docs/.stamp # Install Doxygen generated HTML documentation and manpages diff --git a/bugreport/Makefile.am b/bugreport/Makefile.am index 41fa965..5c3f35e 100644 --- a/bugreport/Makefile.am +++ b/bugreport/Makefile.am @@ -20,3 +20,5 @@ x52bugreport_LDFLAGS = \ $(WARN_LDFLAGS) x52bugreport_LDADD = libx52io.la + +EXTRA_DIST += bugreport/bugreport.dox diff --git a/bugreport/bugreport.dox b/bugreport/bugreport.dox new file mode 100644 index 0000000..d3bbec7 --- /dev/null +++ b/bugreport/bugreport.dox @@ -0,0 +1,22 @@ +/** +@page x52bugreport System information utility for bug reports + +\htmlonly +x52bugreport - System information utility for bug reports +\endhtmlonly + +# SYNOPSIS + +\b x52bugreport + +# DESCRIPTION + +\b x52bugreport is a utility that collects and reports information on the +current system and build environment. The reported information can be provided +when raising a bug report on https://github.com/nirenjan/libx52/issues. + +# USAGE + +\b x52bugreport + +*/