summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
author couriersud <couriersud@gmx.org>2020-08-05 21:43:54 +0200
committer couriersud <couriersud@gmx.org>2020-08-06 09:46:43 +0200
commit2c799e11604986b2845d60b69fd5cac46e8e7b87 (patch)
tree0429d330ba20757e52fc41dd9ba070f12971fa21
parent738e9cc136d869406badcd9a0f094cfd2b040485 (diff)
netlist: add man target to netlist makefile.
-rw-r--r--src/lib/netlist/.gitignore2
-rw-r--r--src/lib/netlist/build/doxygen.conf2
-rw-r--r--src/lib/netlist/build/makefile9
-rw-r--r--src/lib/netlist/build/nltool.help2man5
4 files changed, 15 insertions, 3 deletions
diff --git a/src/lib/netlist/.gitignore b/src/lib/netlist/.gitignore
index 946de7294de..b5665c29b92 100644
--- a/src/lib/netlist/.gitignore
+++ b/src/lib/netlist/.gitignore
@@ -1,3 +1,5 @@
+build/html/*
+build/man/*
build/doxy/*
build/obj/*
buildVS/Release/*
diff --git a/src/lib/netlist/build/doxygen.conf b/src/lib/netlist/build/doxygen.conf
index 110a41acf43..fc500b3aabb 100644
--- a/src/lib/netlist/build/doxygen.conf
+++ b/src/lib/netlist/build/doxygen.conf
@@ -844,7 +844,7 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# command).
-EXAMPLE_PATH = ../documentation ../examples
+EXAMPLE_PATH = ../documentation ../examples ./html
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
diff --git a/src/lib/netlist/build/makefile b/src/lib/netlist/build/makefile
index c4ad5397515..e142f7c0d7e 100644
--- a/src/lib/netlist/build/makefile
+++ b/src/lib/netlist/build/makefile
@@ -251,7 +251,7 @@ MAKEFILE_TARGETS_WITHOUT_INCLUDE := gcc9 clang clang-5 mingw doc native maketree
# PHONY
#-------------------------------------------------
-.PHONY: all gcc9 clang clang-5 mingw doc native maketree $(DEPEND) depend runtests
+.PHONY: all gcc9 clang clang-5 mingw doc man native maketree $(DEPEND) depend runtests
#-------------------------------------------------
# all
@@ -361,8 +361,13 @@ mingw:
# LDEXTRAFLAGS = -municode
#
+man: nltool$(EXESUFFIX) nlwav$(EXESUFFIX)
+ @mkdir -p man
+ @mkdir -p html
+ help2man --include=nltool.help2man --no-info ./nltool$(EXESUFFIX) > man/nltool.1
+ groff -mandoc -Thtml man/nltool.1 > html/nltool.html
-doc: nltool$(EXESUFFIX)
+doc: nltool$(EXESUFFIX) nlwav$(EXESUFFIX)
./nltool$(EXESUFFIX) -c docheader > ../documentation/devsyn.dox.h
$(DOXYGEN) doxygen.conf
diff --git a/src/lib/netlist/build/nltool.help2man b/src/lib/netlist/build/nltool.help2man
new file mode 100644
index 00000000000..76b0f15b8d0
--- /dev/null
+++ b/src/lib/netlist/build/nltool.help2man
@@ -0,0 +1,5 @@
+[see also]
+More documentation for the
+.B nltool
+program is available in doxygen format.
+