Moved manual generation from batch file into cmake.

5 files changed, 83 insertions, 47 deletions

diff --git a/INSTALL.txt b/INSTALL.txt
index 9835199..266fd46 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -46,26 +46,59 @@ the commandline for cmake
 
 Create Man pages
 ----------------
-With the compile option "WITH_MAN=ON" (default value) the man 
-pages will generated. After the call "sudo make install" (see 
-"Compiling in Linux") they are installed at <CMAKE_INSTALL_PREFIX>/share/man. 
+The man pages are generated with following commands.
+They are generated by default (WITH_MAN=ON).
 
-Create doxygen documentation
+----
+mkdir build
+cd build
+cmake ..
+make
+sudo make install
+----
+
+You will find the man pages after installation in <CMAKE_INSTALL_PREFIX>/share/man.
+
+The man pages are generated with asciidoc.
+If the man pages are changed the following command must be executed.
+
+----
+mkdir build
+cd build
+cmake -DWITH_DOC=ON ..
+make doc-man
+----
+
+The generated man pages overwrites the existing ones.
+
+Create manuals documentation
 ----------------------------
-- mkdir build
-- cd build
-- cmake -DWITH_DOC=ON ..
-- make 
-- (only DLT doc - optional )make doc
-- (only DLT-Filetransfer - optional )make doc-filetransfer
+The manuals are generated with asciidoc.
 
-You find the documentation know as HTML, RTF or LaTex in <project-root>/build/doc
+----
+mkdir build
+cd build
+cmake -DWITH_DOC=ON ..
+make doc-manuals
+----
 
-- Doxygen documentation
+You will find the generated documents in build/doc/manuals.
+
+Create api documentation
+------------------------
+The API documentation is generated with doxygen.
+
+----
+mkdir build
+cd build
+cmake -DWITH_DOC=ON ..
+make doc
+----
+
+You will find the generated documents in build/doc/DOC_DLT.
 
 Generation of systemd unit files
 --------------------------------
-
 DLT provides some example unit files for systemd, stored in <DLT-root>/systemd.
 In <DLT-root>/systemd/CMakeLists.txt you have to specify some values, e.g. the port for dlt-adaptor-udp.
 By default the generation of unit files with cmake is off. Please follow these steps to enable the generation:
@@ -92,7 +125,7 @@ If you are behind a proxy you have to set up the Git proxy configuration, e.g.
 git config --global http.proxy $http_proxy
 ----
 
-Checkout the code from the GENIVI Git repository.
+Checkout the code from the OSS Git repository.
 
 ----
 git clone http://git.projects.genivi.org/dlt-daemon.git
diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
index 26f7d22..bfafd2b 100755
--- a/ReleaseNotes.txt
+++ b/ReleaseNotes.txt
@@ -11,6 +11,7 @@ Changes
 

 2.9.0

 

+   * Changed documentation and man pages into asciidoc format.

    * Increased buffer sizes for DLT user library and DLT daemon

    * [GDLT-120]: truncated and Segmented network tracing

    * [GDLT-137]: Automatically try resending of user buffer after FIFO full

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 63091e8..49939ec 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -24,12 +24,42 @@ if(WITH_DOC)
   		WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
 	)
 	
-	add_custom_target (doc-extended-network-trace ALL 
+	add_custom_target (doc-extended-network-trace ALL
   		COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/extended_network_trace_doxygen.cfg
   		WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
 	)
-	
 
+	add_custom_target (doc-manuals ALL
+		COMMAND mkdir -p ${CMAKE_BINARY_DIR}/doc/manuals 
+		COMMAND mkdir -p ${CMAKE_BINARY_DIR}/doc/manuals/images 
+		COMMAND cp ${CMAKE_SOURCE_DIR}/doc/images/* ${CMAKE_BINARY_DIR}/doc/manuals/images 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/INSTALL.html ${CMAKE_SOURCE_DIR}/INSTALL.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/README.html ${CMAKE_SOURCE_DIR}/README.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/ReleaseNotes.html ${CMAKE_SOURCE_DIR}/ReleaseNotes.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_user_manual.html ${CMAKE_SOURCE_DIR}/doc/dlt_user_manual.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_cheatsheet.html ${CMAKE_SOURCE_DIR}/doc/dlt_cheatsheet.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_design_specification.html ${CMAKE_SOURCE_DIR}/doc/dlt_design_specification.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_filetransfer.html ${CMAKE_SOURCE_DIR}/doc/dlt_filetransfer.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-daemon.1.html ${CMAKE_SOURCE_DIR}/doc/dlt-daemon.1.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-system.1.html ${CMAKE_SOURCE_DIR}/doc/dlt-system.1.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-receive.1.html ${CMAKE_SOURCE_DIR}/doc/dlt-receive.1.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-convert.1.html ${CMAKE_SOURCE_DIR}/doc/dlt-convert.1.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt.conf.5.html ${CMAKE_SOURCE_DIR}/doc/dlt.conf.5.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-system.conf.5.html ${CMAKE_SOURCE_DIR}/doc/dlt-system.conf.5.txt 
+  		COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_book.html ${CMAKE_SOURCE_DIR}/doc/dlt_book.txt 
+  		WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
+	)
+
+	add_custom_target (doc-man
+  		WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
+		COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-daemon.1.txt
+		COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-system.1.txt
+		COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-receive.1.txt
+		COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-convert.1.txt 
+		COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt.conf.5.txt
+		COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-system.conf.5.txt
+	)
+	
 endif(WITH_DOC)
 
 if(WITH_MAN)
diff --git a/doc/create_doc.sh b/doc/create_doc.sh
deleted file mode 100755
index 10ba183..0000000
--- a/doc/create_doc.sh
+++ /dev/null
@@ -1,28 +0,0 @@
-#!/bin/bash
-
-asciidoc -a toc2 dlt_user_manual.txt
-asciidoc -a toc2 dlt_design_specification.txt
-asciidoc -a toc2 dlt_cheatsheet.txt
-asciidoc -a toc2 dlt_filetransfer.txt
-
-asciidoc -a toc2 dlt-daemon.1.txt
-a2x --doctype manpage --format manpage dlt-daemon.1.txt
-asciidoc -a toc2 dlt.conf.5.txt
-a2x --doctype manpage --format manpage dlt.conf.5.txt
-asciidoc -a toc2 dlt-convert.1.txt
-a2x --doctype manpage --format manpage dlt-convert.1.txt
-asciidoc -a toc2 dlt-receive.1.txt
-a2x --doctype manpage --format manpage dlt-receive.1.txt
-asciidoc -a toc2 dlt-system.1.txt
-a2x --doctype manpage --format manpage dlt-system.1.txt
-asciidoc -a toc2 dlt-system.conf.5.txt
-a2x --doctype manpage --format manpage dlt-system.conf.5.txt
-
-asciidoc -a toc2 dlt_book.txt
-
-cd ..
-
-asciidoc -a toc2 README.txt
-asciidoc -a toc2 INSTALL.txt
-asciidoc -a toc2 ReleaseNotes.txt
-
diff --git a/doc/dlt_book.txt b/doc/dlt_book.txt
index 3a114f5..ecbf744 100644
--- a/doc/dlt_book.txt
+++ b/doc/dlt_book.txt
@@ -12,7 +12,7 @@ This document combines all DLT documents into a single document.
 Information
 -----------
 
-:leveloffset: 2
+:leveloffset: 1
 
 include::../README.txt[]
 include::../INSTALL.txt[]
@@ -23,7 +23,7 @@ include::../ReleaseNotes.txt[]
 Manpages
 --------
 
-:leveloffset: 2
+:leveloffset: 1
 
 include::dlt-daemon.1.txt[]
 include::dlt.conf.5.txt[]
@@ -37,7 +37,7 @@ include::dlt-receive.1.txt[]
 Manuals
 -------
 
-:leveloffset: 2
+:leveloffset: 1
 
 include::dlt_user_manual.txt[]
 include::dlt_cheatsheet.txt[]