summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt122
1 files changed, 49 insertions, 73 deletions
diff --git a/README.txt b/README.txt
index f317849..a6d2c08 100644
--- a/README.txt
+++ b/README.txt
@@ -1,11 +1,14 @@
-DLT - Automotive Diagnostic Log and Trace
-
-Version: 2.9.0 RELEASE
+Diagnostic Log and Trace - Readme
+==================================
+Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
+Overview
+--------
This component provides a standardised log and trace interface, based on the
standardised protocol specified in the AUTOSAR standard 4.0 DLT.
This component can be used by GENIVI components and other applications as
logging facility providing
+
- the DLT shared library
- the DLT daemon
- the DLT daemon adaptors
@@ -20,84 +23,57 @@ The DLT client can send control messages to the daemon, e.g. to set
individual log levels of applications and contexts or get the list of
applications and contexts registered in the DLT daemon.
+Documentation
+-------------
+- DLT Release Notes: ReleaseNotes.txt
+- DLT Installation: INSTALL.txt
+- DLT User Manual: doc/dlt_user_manual.txt
+- DLT Cheatsheet: doc/dlt_cheatsheet.txt
+- DLT Design Specification :doc/dlt_design_specification.txt
-Homepage
---------
-https://collab.genivi.org/wiki/display/geniviproj/Automotive+DLT+%28Diagnostic+Log+and+Trace%29
+API Documentation
+-----------------
+See INSTALL.txt regarding doxygen API documentation generation.
+Manpages
+--------
+- dlt-daemon(1)
+- dlt.conf(5)
+- dlt-system(1)
+- dlt-system.conf(5)
+- dlt-receive(1)
+- dlt-convert(9)
+
+Known issues
+------------
+- DLT library: Usage of dlt_user_log_write_float64() and DLT_FLOAT64() leads to "Illegal instruction (core dumped)" on ARM target.
+- DLT library: Nested calls to DLT_LOG_ ... are not supported, and will lead to a deadlock.
+
+Software/Hardware
+-----------------
+Developped and tested with Ubuntu Linux 12.04 32-bit / Intel PC
License
-------
-Full information on the license for this software
-is available in the "LICENSE.txt" file.
-The full MPL license is in "MPL.txt."
-
-
-Contact
--------
-Alexander Wenzel (Alexander.AW.Wenzel@bmw.de)
-Christian Muck (christian.muck@bmw.de)
+Full information on the license for this software is available in the "LICENSE.txt" file.
+Source Code
+-----------
+git://git.projects.genivi.org/dlt-daemon.git
+http://git.projects.genivi.org/dlt-daemon.git
+ssh://git-genivi@git.projects.genivi.org/dlt-daemon.git
-Compiling in Linux:
--------------------
-- mkdir build
-- cd build
-- cmake ..
-- make
-- optional: sudo make install
-- optional: sudo ldconfig
-
-
-Compile options with default values
------------------------------------
-- 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
-- Change a value with: cmake -D<Variable>=<Value>
-- Example: cmake -DCMAKE_INSTALL_PREFIX=/usr
-
-
-Man pages
----------
-With the compile option "WITH_MAN=ON" (default value) the man
-pages will generated. After the call "sudo make install" (see
-"Compilin in Linux") they are installed at <CMAKE_INSTALL_PREFIX>/share/man.
+Homepage
+--------
+http://projects.genivi.org/diagnostic-log-trace
-To get more informations, call e.g.
-- man dlt-daemon
-- man dlt.conf
-- man dlt-convert
-- man dlt-receive
-- man dlt-system
-- man dlt-system.conf
+Mailinglist
+-----------
+https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-and-trace
+Contact
+-------
+Alexander Wenzel <Alexander.AW.Wenzel@bmw.de> +
+Christian Muck <christian.muck@bmw.de>
-Create doxygen documentation
-----------------------------
-- mkdir build
-- cd build
-- cmake -DWITH_DOC=ON ..
-- make
-- (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