Updated doxygen documentation, readme, man pages and release notes

Signed-off-by: Christian Muck <christian.muck@bmw.de>

19 files changed, 172 insertions, 64 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 2fc55f6..9b36c8e 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -50,21 +50,21 @@ if(NOT CMAKE_BUILD_TYPE)
 endif(NOT CMAKE_BUILD_TYPE)

 

 # Set of indiviual options

-option(BUILD_SHARED_LIBS      "Set to OFF to build static libraries"                 ON  )

+option(BUILD_SHARED_LIBS      "Set to OFF to build static libraries"                                             ON  )

 option(WITH_SYSTEMD           "Set to ON to create unit files and systemd check on dlt-daemon startup"           OFF )

-option(WITH_SYSTEMD_WATCHDOG  "Set to ON to use the systemd watchdog in dlt-daemon"      OFF)

-option(WITH_DOC               "Set to ON to build documentation target"              OFF )

-option(WITH_MAN               "Set to ON to build man pages"             ON )

+option(WITH_SYSTEMD_WATCHDOG  "Set to ON to use the systemd watchdog in dlt-daemon"                              OFF)

+option(WITH_DOC               "Set to ON to build documentation target"                                          OFF )

+option(WITH_MAN               "Set to ON to build man pages"                                                     ON )

 option(WITH_CHECK_CONFIG_FILE "Set to ON to create a configure file of CheckIncludeFiles and CheckFunctionExists " OFF )

-option(WITH_TESTSCRIPTS       "Set to ON to run CMakeLists.txt in testscripts"       OFF )

-option(WITH_GPROF             "Set -pg to compile flags"                             OFF )

+option(WITH_TESTSCRIPTS       "Set to ON to run CMakeLists.txt in testscripts"                                   OFF )

+option(WITH_GPROF             "Set -pg to compile flags"                                                         OFF )

 option(WITH_DLTTEST			  "Set to ON to build with modifications to test User-Daemon communication with corrupt messages" OFF)

-option(WITH_DLT_SHM_ENABLE    "EXPERIMENTAL! Set to ON to use shared memory as IPC. EXPERIMENTAL!"    OFF )

-option(WTIH_DLT_ADAPTOR       "Set ton ON to build src/adaptor binaries" ON)

-option(WITH_DLT_CONSOLE       "Set ton ON to build src/console binaries" ON)

-option(WITH_DLT_EXAMPLES      "Set ton ON to build src/examples binaries" ON)

-option(WITH_DLT_SYSTEM        "Set ton ON to build src/system binaries" ON)

-option(WITH_DLT_TESTS         "Set ton ON to build src/test binaries" ON)

+option(WITH_DLT_SHM_ENABLE    "EXPERIMENTAL! Set to ON to use shared memory as IPC. EXPERIMENTAL!"               OFF )

+option(WTIH_DLT_ADAPTOR       "Set ton ON to build src/adaptor binaries"                                         ON)

+option(WITH_DLT_CONSOLE       "Set ton ON to build src/console binaries"                                         ON)

+option(WITH_DLT_EXAMPLES      "Set ton ON to build src/examples binaries"                                        ON)

+option(WITH_DLT_SYSTEM        "Set ton ON to build src/system binaries"                                          ON)

+option(WITH_DLT_TESTS         "Set ton ON to build src/test binaries"                                            ON)

 # RPM settings

 set( GENIVI_RPM_RELEASE "1")#${DLT_REVISION}")

 set( LICENSE "Mozilla Public License Version 2.0" )

diff --git a/INSTALL.txt b/INSTALL.txt
index 8f65e7c..d58d83e 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -2,7 +2,7 @@ Instructions for installing this software
 -----------------------------------------
 
 This software uses cmake as its build tool. To build and install the
-DLT daemon, follow these steps;
+DLT daemon, follow these steps:
 
 - mkdir build
 - cd build
@@ -13,6 +13,6 @@ DLT daemon, follow these steps;
 
 
 Please read the README.txt for
-- Compile options and default values
+- Compile options
 - Man pages
 - Doxygen documentation
\ No newline at end of file
diff --git a/README.txt b/README.txt
index 22ebfdf..ddbc0ee 100644
--- a/README.txt
+++ b/README.txt
@@ -1,6 +1,6 @@
 DLT  - Automotive Diagnostic Log and Trace
 
-Version: 2.7.0 ALPHA
+Version: 2.7.0
 
 This component provides a standardised log and trace interface, based on the
 standardised protocol specified in the AUTOSAR standard 4.0 DLT.
@@ -51,19 +51,24 @@ Compiling in Linux:
 
 Compile options with default values
 -----------------------------------
-- WITH_DLT_SHM_ENABLE =        OFF
-- WITH_CHECK_CONFIG_FILE =     OFF
-- WITH_DOC =                   OFF
-- WITH_TESTSCRIPTS =           OFF
-- WITH_SYSTEMD =               OFF
-- WITH_GPROF =  	       OFF
-- WITH_MAN =		       ON
-- WITH_DLTTEST =               OFF
-- BUILD_SHARED_LIBS =          ON
-- CMAKE_INSTALL_PREFIX =       /usr/local
+- WITH_SYSTEMD =        		OFF
+- WITH_SYSTEMD_WATCHDOG =		OFF
+- WTIH_DLT_ADAPTOR =        	ON
+- WITH_DLT_CONSOLE =        	ON
+- WITH_DLT_EXAMPLES =        	ON
+- WITH_DLT_SYSTEM =        		ON
+- WITH_DLT_EXAMPLES =        	ON
+- WITH_DLT_TESTS =        		ON
+- WITH_CHECK_CONFIG_FILE =     	OFF
+- WITH_DOC =                   	OFF
+- WITH_TESTSCRIPTS =           	OFF
+- WITH_GPROF =  	       		OFF
+- WITH_MAN =		       		ON
+- WITH_DLTTEST =               	OFF
+- BUILD_SHARED_LIBS =          	ON
+- CMAKE_INSTALL_PREFIX =       /usr
 - CMAKE_BUILD_TYPE =           RelWithDebInfo
 
-
 In order to change these options, you can modify this values
 with ccmake, do the appropriate changes in CmakeList.txt or via 
 the commandline for cmake
@@ -95,4 +100,4 @@ Create doxygen documentation
 - (only DLT doc - optional )make doc
 - (only DLT-Filetransfer - optional )make doc-filetransfer
 
-You find the documentation know as HTML, RTF or LaTex in <project-root>/build/doc
+You find the documentation know as HTML, RTF or LaTex in <project-root>/build/doc
\ No newline at end of file
diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
index 9f25ffe..8136811 100755
--- a/ReleaseNotes.txt
+++ b/ReleaseNotes.txt
@@ -1,6 +1,6 @@
 DLT - Automotive Diagnostic Log and Trace

 

-Version: 2.6.0

+Version: 2.7.0

 

 This component provides a standardised log and trace interface, based on the

 standardised protocol specified in the AUTOSAR standard 4.0 DLT.

@@ -38,10 +38,32 @@ Contact
 Alexander Wenzel (Alexander.AW.Wenzel@bmw.de)

 Christian Muck (christian.muck@bmw.de)

 

-

 Changes in this release

 -----------------------

 

+2.7.0

+

+   * [GDLT-24] Fixing compiler warnings

+   * [GDLT-94] Optional sending periodic software version messages. See man pages for more informations

+   * [GENDLT-26] Check for description length sanity

+   * [GENDLT-24] Crash on invalid injection message fixed

+   * [GDLT-93] Add -Wextra flags for compilation Fixed all the warnings that

+   * [GDLT-90] Optional: systemd watchdog concept in dlt-system and dlt-daemon

+   * [GDLT-67] Re-implemented dlt-system. Read full commit message for more information

+   * [GDLT-89] Fixed daemon doesn't sent the persistent log level

+   * [GDLT-88] Fixed wrong initalization order using offline trace function

+   * Add _GNU_SOURCE Definition to be able to use O_CLOEXEC

+   * Added important SEM_FREE in the daemon and closing fd in the filetransfer

+   * [GDLT-3] Fixed missing semaphore around dlt_buffer_push3

+   * [GDLT-86] Fixed dlt_free uses absolute file path /tmp and not DLT_USER_DEFINE define

+   * [D4099] Check for duplicate file handles, and clean them up if found

+   * [GDLT-85] Pipes opened multiple times for the same application pid fixed

+   * [GDLT-82] Child process inherits file descriptors openend by their parent fixed

+   * [GDLT-84] Instead of calling the injection callback, store a pointer to it and the required parameter data fixed

+   * [GDLT-70] Check for malloc failures and return errors where applicable

+   * [GDLT-47] Avoid discarding old contexts if no new memory can be allocate

+   * [GDLT-69] Fixed bug in dlt-test-multi-process shares context between threads

+   

 2.6.0

    

    * [GDLT-75] Use old style directory check on startup

diff --git a/automotive-dlt.pc.in b/automotive-dlt.pc.in
index b0a766f..2008d9f 100755
--- a/automotive-dlt.pc.in
+++ b/automotive-dlt.pc.in
@@ -7,6 +7,6 @@ Name: DLT
 Description: Diagnostic Log and Trace 
 Version: @DLT_VERSION@
 Requires: 
-Libs: -L${libdir} -ldlt -lrt -lpthread
+Libs: -L${libdir} -ldlt -lrt -lpthread -lz
 Cflags: -I${includedir}/dlt -DDLT_@DLT_MAJOR_VERSION@_@DLT_MINOR_VERSION@
 
diff --git a/automotive-dlt.spec.in b/automotive-dlt.spec.in
index 2ab48ec..7dea8b3 100644
--- a/automotive-dlt.spec.in
+++ b/automotive-dlt.spec.in
@@ -117,7 +117,3 @@ rm -rf $RPM_BUILD_ROOT
 %files devel
 %{_includedir}/dlt/*.h
 %{_libdir}/pkgconfig/@PROJECT_NAME@.pc
-
-%changelog
-* Wed Nov 24 2010 dlt_maintainer <dlt_maintainer@genivi.org> 2.2.0
-- Creation
diff --git a/doc/dlt-convert.1 b/doc/dlt-convert.1
index 5ae5db9..5a29267 100644
--- a/doc/dlt-convert.1
+++ b/doc/dlt-convert.1
@@ -1,4 +1,4 @@
-.TH dlt-convert 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-convert 1 "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt-convert \- Convert DLT Logging files into ASCII
 .SH SYNOPSIS
diff --git a/doc/dlt-daemon.1 b/doc/dlt-daemon.1
index 34edfc6..c971ff3 100644
--- a/doc/dlt-daemon.1
+++ b/doc/dlt-daemon.1
@@ -1,4 +1,4 @@
-.TH dlt-daemon 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-daemon 1   "April 13, 2012" "version 2.7.0"  "USER COMMANDS"
 .SH NAME
 dlt-daemon \- DLT daemon for logging and tracing purpose
 .SH SYNOPSIS
diff --git a/doc/dlt-receive.1 b/doc/dlt-receive.1
index 8d08ac4..3a96e70 100644
--- a/doc/dlt-receive.1
+++ b/doc/dlt-receive.1
@@ -1,4 +1,4 @@
-.TH dlt-receive 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-receive 1   "April 13, 2012" "version 2.7.0"  "USER COMMANDS"
 .SH NAME
 dlt-receive \- Console based client for DLT Logging
 .SH SYNOPSIS
diff --git a/doc/dlt-system.1 b/doc/dlt-system.1
index 2291b9e..1484063 100644
--- a/doc/dlt-system.1
+++ b/doc/dlt-system.1
@@ -1,4 +1,4 @@
-.TH dlt-system 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-system 1   "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt-system \- DLT system logging process
 .SH SYNOPSIS
diff --git a/doc/dlt-system.conf.5 b/doc/dlt-system.conf.5
index c8319aa..2680a78 100644
--- a/doc/dlt-system.conf.5
+++ b/doc/dlt-system.conf.5
@@ -1,4 +1,4 @@
-.TH dlt-system.conf 5  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-system.conf 5  "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt-system.conf \- DLT system process configuration file
 .SH DESCRIPTION
@@ -44,24 +44,40 @@ If this option is set to 1, the filetransfer feature is enabled.
 .IP
 Default: 0.
 .TP
-.B FiletransferDirectory1
-This is path to the first directory, which is scanned for new files to
-be transfered. If new files are found, these files are transfered to the
-client and then deleted after a configurable time.
+.B FiletransferContextId
+The Context Id of the filetransfer.
 .IP
-Default: /tmp/filetransfer
+Default: File.
 .TP
-.B FiletransferDirectory2
-This is path to the second directory, which is scanned for new files to
-be transfered. If new files are found, these files are transfered to the
-client and then deleted after a configurable time.
+.B FiletransferTimeStartup
+Time in seconds after startup of dlt-system when first file is transfered.
 .IP
-Default: /tmp/filetransfer2
+Default: 30.
 .TP
-.B SyslogContextId
-This value defines context id of the syslog adapter. 
+.B FiletransferTimeoutBetweenLogs
+Time in ms seconds to wait between two file transfer logs of a single file to DLT.
 .IP
-Default: SYSL
+Default: 10.
+.TP
+.B FiletransferTempDir
+Temporary directory to use. File transfer will move a file to this directory while it is being compressed and sent.
+.IP
+Default: /tmp.
+.TP
+.B FiletransferDirectory
+You can define multiple file transfer directories Define the directory to watch, whether to compress the file with zlib and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values..
+.IP
+Default: /var/dlt/ft1.
+.TP
+.B FiletransferCompression
+You can define multiple file transfer directories. Define the directory to watch, whether to compress the file with zlib and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values..
+.IP
+Default: 0.
+.TP
+.B FiletransferCompressionLevel
+You can define multiple file transfer directories Define the directory to watch, whether to compress the file with zlib and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values..
+.IP
+Default: 5.
 .TP
 .B FiletransferTimeStartup
 This value defines the amount of time in seconds after start of
diff --git a/doc/dlt.conf.5 b/doc/dlt.conf.5
index ea55116..c77fba0 100644
--- a/doc/dlt.conf.5
+++ b/doc/dlt.conf.5
@@ -1,4 +1,4 @@
-.TH dlt.conf 5  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt.conf 5 "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt.conf \- DLT daemon configuration file
 .SH DESCRIPTION
@@ -137,8 +137,15 @@ Default: Function is disabled
 Each received DLT message on a TCP connection is checked to contain a
 serial header. If the DLT message contains no serial header, the message
 is ignored.
+.SH ECU Software version info
+.TP
+.B SendECUSoftwareVersion
+Send periodic ECU version info. 0=disabled, 1=enabled.
 .IP
-Default:
+Default: 0
+.TP
+.B PathToECUSoftwareVersion
+Absolute path to file storing version information - if disabled the DLT version will be send.
 .SH AUTHOR
 Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
 .SH SEE ALSO
diff --git a/doc/doxygen.cfg.cmake b/doc/doxygen.cfg.cmake
index ded84c3..13eec96 100755
--- a/doc/doxygen.cfg.cmake
+++ b/doc/doxygen.cfg.cmake
@@ -573,7 +573,8 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT = ./../../src/ \ 
+INPUT = ./../../doc/mainpage.h \
+        ./../../src/ \ 
         ./../../include
 
 
@@ -671,7 +672,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = @CMAKE_SOURCE_DIR@/doc/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
diff --git a/doc/filetransfer_doxygen.cfg.cmake b/doc/filetransfer_doxygen.cfg.cmake
index aa2a3b3..a446c05 100755
--- a/doc/filetransfer_doxygen.cfg.cmake
+++ b/doc/filetransfer_doxygen.cfg.cmake
@@ -673,7 +673,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = @CMAKE_SOURCE_DIR@/doc/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
diff --git a/doc/filetransfer_mainpage.h b/doc/filetransfer_mainpage.h
index d1a2f6b..047e483 100755
--- a/doc/filetransfer_mainpage.h
+++ b/doc/filetransfer_mainpage.h
@@ -1,4 +1,35 @@
-/** \mainpage DLT Filetransfer Main documentation page
+/**
+ * @licence app begin@
+ * Copyright (C) 2012  BMW AG
+ *
+ * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.
+ *
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ *
+ * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012
+ *
+ * For further information see http://www.genivi.org/.
+ * @licence end@
+ */
+ 
+/** \mainpage 
+
+\image html genivilogo.png
+
+\par More information
+can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n
+
+\par About DLT
+The DLT is a Deamon that enables diagnostic log and trace in a GENIVI headunit and is based on AUTOSAR 4.0.
+
+DLT Filetransfer Main documentation page
 
 \section Introduction Introduction
 DLT Filetransfer enables the feature to store the binary data of a file to the automotive dlt log. The file will
diff --git a/doc/images/genivilogo.png b/doc/images/genivilogo.png
new file mode 100644
index 0000000..d016ec8
--- /dev/null
+++ b/doc/images/genivilogo.png
diff --git a/doc/mainpage.h b/doc/mainpage.h
new file mode 100644
index 0000000..e6a4a00
--- /dev/null
+++ b/doc/mainpage.h
@@ -0,0 +1,32 @@
+/**
+ * @licence app begin@
+ * Copyright (C) 2012  BMW AG
+ *
+ * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.
+ *
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ *
+ * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012
+ *
+ * For further information see http://www.genivi.org/.
+ * @licence end@
+ */
+ 
+/*!
+\mainpage
+
+\image html genivilogo.png
+
+\par More information
+can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n
+
+\par About DLT
+The DLT is a Deamon that enables diagnostic log and trace in a GENIVI headunit and is based on AUTOSAR 4.0.
+*/
diff --git a/src/daemon/dlt.conf b/src/daemon/dlt.conf
index c97e8e6..909d4f4 100644
--- a/src/daemon/dlt.conf
+++ b/src/daemon/dlt.conf
@@ -93,8 +93,8 @@ LoggingFilename = /tmp/dlt.log
 # ECU Software version info                                            #
 ########################################################################
 
-# Send automatic get ecu version info
+# Send periodic get ecu version info (Default: 0)
 # SendECUSoftwareVersion = 0
 
 # Absolute path to file storing version info - otherwise DLT version is used
-# PathToECUSoftwareVersion = <absolute-path-to-file-needed>
+# PathToECUSoftwareVersion = <absolute-path-to-file>
diff --git a/src/system/dlt-system.conf b/src/system/dlt-system.conf
index c7313eb..10de9c1 100644
--- a/src/system/dlt-system.conf
+++ b/src/system/dlt-system.conf
@@ -31,16 +31,14 @@ FiletransferEnable = 0
 # The Context Id of the filetransfer (Default: FILE)
 FiletransferContextId = FILE
 
-# Time after startup of dlt-system when first file is transfered (Default: 30)
-# Time in seconds
+# Time in seconds after startup of dlt-system when first file is transfered (Default: 30)
 FiletransferTimeStartup = 30
 
 # Time to wait when transfered file is deleted and next file transfer starts (Default: 10)
 # Time in seconds
 FiletransferTimeDelay = 10
 
-# Time to wait between two file transfer logs of a single file to DLT.  (Default: 10)
-# Time in ms seconds
+# Time in ms seconds to wait between two file transfer logs of a single file to DLT.  (Default: 10)
 FiletransferTimeoutBetweenLogs = 10
 
 # Temporary directory to use.