summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLutz Helwing <lutz_helwing@mentor.com>2015-07-13 16:52:14 +0200
committerAlexander Wenzel <Alexander.AW.Wenzel@bmw.de>2015-07-21 12:48:27 +0200
commit98e932adee2a76bda3c2630f348196216549a45a (patch)
tree1658983ac5940b71c158da20421db9054f9500ca /doc
parent199ff0e7f736d848a7e01a12f04ddb21ecf36d74 (diff)
downloadDLT-daemon-98e932adee2a76bda3c2630f348196216549a45a.tar.gz
Removed all trailing whitespaces
Signed-off-by: Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt74
-rw-r--r--doc/dlt-convert.1.txt4
-rw-r--r--doc/dlt-receive.1.txt4
-rw-r--r--doc/dlt-system.1.txt4
-rw-r--r--doc/dlt-system.conf.5.txt12
-rw-r--r--doc/dlt.conf.5.txt6
-rw-r--r--doc/dlt_cheatsheet.txt28
-rw-r--r--doc/dlt_design_specification.txt18
-rw-r--r--doc/dlt_extended_network_trace.txt6
-rw-r--r--doc/dlt_filetransfer.txt8
-rw-r--r--doc/dlt_howto_debug.txt18
-rw-r--r--doc/dlt_user_manual.txt16
-rwxr-xr-xdoc/doxygen.cfg.cmake4
-rwxr-xr-xdoc/extended_network_trace_doxygen.cfg.cmake4
-rw-r--r--doc/mainpage.h2
15 files changed, 104 insertions, 104 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index c001f66..b8f0ae8 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -17,34 +17,34 @@
if(WITH_DOC)
find_package(Doxygen)
-
+
configure_file(${CMAKE_SOURCE_DIR}/doc/doxygen.cfg.cmake ${CMAKE_BINARY_DIR}/doc/doxygen.cfg @ONLY)
- add_custom_target (doc ALL
- COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/doxygen.cfg
+ add_custom_target (doc ALL
+ COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/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 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
COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/README.html ${CMAKE_SOURCE_DIR}/README
- 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/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
- COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_extended_network_trace.html ${CMAKE_SOURCE_DIR}/doc/dlt_extended_network_trace.txt
- COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_howto_debug.html ${CMAKE_SOURCE_DIR}/doc/dlt_howto_debug.txt
+ COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_extended_network_trace.html ${CMAKE_SOURCE_DIR}/doc/dlt_extended_network_trace.txt
+ COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_howto_debug.html ${CMAKE_SOURCE_DIR}/doc/dlt_howto_debug.txt
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
)
@@ -53,7 +53,7 @@ if(WITH_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-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
)
@@ -69,27 +69,27 @@ if(WITH_MAN)
/usr/local/bin)
if(NOT GZIP_TOOL)
- MESSAGE(FATAL_ERROR "Could not find gzip for man page compression.")
- endif(NOT GZIP_TOOL)
+ MESSAGE(FATAL_ERROR "Could not find gzip for man page compression.")
+ endif(NOT GZIP_TOOL)
set(MAN_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR})
set(MAN_BUILD_DIR ${CMAKE_BINARY_DIR}/doc)
- set(MAN_SRC ${MAN_SRC_DIR}/dlt.conf.5
- ${MAN_SRC_DIR}/dlt-system.conf.5
- ${MAN_SRC_DIR}/dlt-convert.1
- ${MAN_SRC_DIR}/dlt-daemon.1
- ${MAN_SRC_DIR}/dlt-receive.1
+ set(MAN_SRC ${MAN_SRC_DIR}/dlt.conf.5
+ ${MAN_SRC_DIR}/dlt-system.conf.5
+ ${MAN_SRC_DIR}/dlt-convert.1
+ ${MAN_SRC_DIR}/dlt-daemon.1
+ ${MAN_SRC_DIR}/dlt-receive.1
${MAN_SRC_DIR}/dlt-system.1)
- set(MAN_BUILD_SRC
- ${MAN_BUILD_DIR}/dlt.conf.5
- ${MAN_BUILD_DIR}/dlt-system.conf.5
- ${MAN_BUILD_DIR}/dlt-convert.1
- ${MAN_BUILD_DIR}/dlt-daemon.1
- ${MAN_BUILD_DIR}/dlt-receive.1
+ set(MAN_BUILD_SRC
+ ${MAN_BUILD_DIR}/dlt.conf.5
+ ${MAN_BUILD_DIR}/dlt-system.conf.5
+ ${MAN_BUILD_DIR}/dlt-convert.1
+ ${MAN_BUILD_DIR}/dlt-daemon.1
+ ${MAN_BUILD_DIR}/dlt-receive.1
${MAN_BUILD_DIR}/dlt-system.1)
- set(MAN_BUILD_GZ
- ${MAN_BUILD_DIR}/dlt.conf.5.gz
+ set(MAN_BUILD_GZ
+ ${MAN_BUILD_DIR}/dlt.conf.5.gz
${MAN_BUILD_DIR}/dlt-system.conf.5.gz
${MAN_BUILD_DIR}/dlt-convert.1.gz
${MAN_BUILD_DIR}/dlt-daemon.1.gz
@@ -97,10 +97,10 @@ if(WITH_MAN)
${MAN_BUILD_DIR}/dlt-system.1.gz)
foreach(MAN ${MAN_SRC})
- execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${MAN} ${MAN_BUILD_DIR})
+ execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${MAN} ${MAN_BUILD_DIR})
endforeach(MAN)
- add_custom_target(compress_man ALL
+ add_custom_target(compress_man ALL
COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt.conf.5 > ${MAN_BUILD_DIR}/dlt.conf.5.gz
COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-system.conf.5 > ${MAN_BUILD_DIR}/dlt-system.conf.5.gz
COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-convert.1 > ${MAN_BUILD_DIR}/dlt-convert.1.gz
diff --git a/doc/dlt-convert.1.txt b/doc/dlt-convert.1.txt
index 17ff71e..ff2c3fa 100644
--- a/doc/dlt-convert.1.txt
+++ b/doc/dlt-convert.1.txt
@@ -14,7 +14,7 @@ DESCRIPTION
-----------
Read DLT files, print DLT messages as ASCII and store the messages again.
Use Ranges and Output file to cut DLT files.
-Use two files and Output file to join DLT files.
+Use two files and Output file to join DLT files.
OPTIONS
-------
@@ -26,7 +26,7 @@ OPTIONS
*-x*::
Print DLT file; payload as hex.
-
+
*-m*::
Print DLT file; payload as hex and ASCII.
diff --git a/doc/dlt-receive.1.txt b/doc/dlt-receive.1.txt
index 1c9e8be..4f1d933 100644
--- a/doc/dlt-receive.1.txt
+++ b/doc/dlt-receive.1.txt
@@ -12,7 +12,7 @@ SYNOPSIS
DESCRIPTION
-----------
-Receive DLT messages from DLT daemon and print or store the messages.
+Receive DLT messages from DLT daemon and print or store the messages.
OPTIONS
-------
@@ -53,7 +53,7 @@ Print received message headers received from a dlt-daemon running on localhost::
Print received message headers received from a serila interface::
dlt-receive -s -y /dev/ttySO
-
+
Store received message headers from a dlt-daemon to a log file called log.dlt and filter them for e.g. Application ID ABCD and Context ID EFGH (Write:ABCD EFGH as single line to a file claled filter.txt)::
dlt-receive -s -o log.dlt -f filter.txt localhost
diff --git a/doc/dlt-system.1.txt b/doc/dlt-system.1.txt
index 6b26b6b..8ba573c 100644
--- a/doc/dlt-system.1.txt
+++ b/doc/dlt-system.1.txt
@@ -16,9 +16,9 @@ The DLT system logging process is the central application, which logs
system information from the platform. It provides the features
filetransfer, syslog adapater, logging of any kind of files and
procfilesystem logger. The individual features can be enabled and
-disabled in the configuration file.
+disabled in the configuration file.
-dlt-system loads by default the configuration file /etc/dlt-system.conf.
+dlt-system loads by default the configuration file /etc/dlt-system.conf.
See dlt-system.conf(1).
OPTIONS
diff --git a/doc/dlt-system.conf.5.txt b/doc/dlt-system.conf.5.txt
index 60bed26..0b73481 100644
--- a/doc/dlt-system.conf.5.txt
+++ b/doc/dlt-system.conf.5.txt
@@ -12,7 +12,7 @@ The DLT system logging process is the central application, which logs
system information from the platform. It provides the features
filetransfer, syslog adapater, logging of any kind of files and
procfilesystem logger. The individual features can be enabled and
-disabled in the configuration file.
+disabled in the configuration file.
The configuration file dlt-system.conf allows to configure the different
runtime behaviour of dlt-system. The configuration file is loaded
@@ -38,7 +38,7 @@ SYSLOG ADAPTER OPTIONS
Default: 0.
*SyslogContextId*::
- This value defines context id of the syslog adapter.
+ This value defines context id of the syslog adapter.
Default: SYSL
@@ -107,7 +107,7 @@ FILETRANSFER OPTIONS
Default: 10
*FiletransferTimeoutBetweenLogs*::
- This value defines the amount of time to wait between two file transfer
+ This value defines the amount of time to wait between two file transfer
logs of a single file.
Default: 10
@@ -121,7 +121,7 @@ LOG FILES OPTIONS
Default: 0.
*LogFileFilename*::
- This value sets the full filename path to the file, which should be logged.
+ This value sets the full filename path to the file, which should be logged.
*LogFileMode*::
This value the defines in which operation mode this file is logged.
@@ -151,13 +151,13 @@ LOG PROCESSES OPTIONS
*LogProcessName*::
This value defines the name of the process to be logged, as used in the
- file stat of each process.
+ file stat of each process.
If the value is defined as *, all processes are logged.
*LogProcessFilename*::
This value sets the relative filename path to the file, which should be
logged. The path is relative to the procfilesystem folder of the
- process.
+ process.
*LogProcessMode*::
This value the defines in which operation mode this process file is
diff --git a/doc/dlt.conf.5.txt b/doc/dlt.conf.5.txt
index b21ab18..0ee3453 100644
--- a/doc/dlt.conf.5.txt
+++ b/doc/dlt.conf.5.txt
@@ -65,7 +65,7 @@ GENERAL OPTIONS
*PersistanceStoragePath*::
This is the directory path, where the DLT daemon stores its runtime
configuration. Runtime configuration includes stored log levels, trace
- status and changed logging mode.
+ status and changed logging mode.
Default: /tmp
@@ -82,7 +82,7 @@ OFFLINE TRACE OPTIONS
*OfflineTraceFileSize*::
This value defines the max size of a offline trace file, if offline trace
is enabled. This value is defined in bytes. If the files size of the
- current used log file is exceeded, a new log file is created.
+ current used log file is exceeded, a new log file is created.
Default: 1000000
@@ -123,7 +123,7 @@ SERIAL CLIENT OPTIONS
*RS232DeviceName*::
If this value is set to a serial device name, e.g. /dev/ttyS0, a serial
- port is used for logging to a client.
+ port is used for logging to a client.
Default: Serial port for logging is disabled
diff --git a/doc/dlt_cheatsheet.txt b/doc/dlt_cheatsheet.txt
index 2d52cac..2ca1586 100644
--- a/doc/dlt_cheatsheet.txt
+++ b/doc/dlt_cheatsheet.txt
@@ -49,10 +49,10 @@ pkg_check_modules(DLT REQUIRED automotive-dlt)
----
and use the variables $\{DLT_INCLUDE_DIRS\} and $\{DLT_LIBRARIES\} for the DLT include and library paths.
-
+
Include the DLT Header
----------------------
-To use DLT you have to include the DLT header file in each file you want to use DLT.
+To use DLT you have to include the DLT header file in each file you want to use DLT.
----
#include <dlt/dlt.h>
@@ -74,7 +74,7 @@ int main(int argc, const char\* argv\[\])
}
----
-.Important notes:
+.Important notes:
* If your application uses fork(), you may not call DLT_REGISTER_APP before fork(). And fork() should never be called after DLT_REGISTER_APP. This is because of state information and inter process communication channel to daemon would be copied to new process, but threads would be not. If you are not sure where you are calling DLT_REGISTER_APP() the first time, you can initialise the DLT user library by calling the initialisation routine directly.
----
dlt_user_init();
@@ -141,7 +141,7 @@ The log level must be one of the following values:
| Log level | Description
| DLT_LOG_FATAL | fatal system error
| DLT_LOG_ERROR | error with impact to correct functionality
-| DLT_LOG_WARN | warning, correct behaviour could not be ensured
+| DLT_LOG_WARN | warning, correct behaviour could not be ensured
| DLT_LOG_INFO | informational (default)
| DLT_LOG_DEBUG | debug
| DLT_LOG_VERBOSE | highest grade of information
@@ -166,11 +166,11 @@ The size of all logging parameters together should not exceed 2kBytes, including
| DLT_STRING(TEXT) | String
| DLT_RAW(BUF,LENGTH) | Raw buffer
| DLT_INT(VAR) | Integer variable, dependent on platform
-| DLT_INT16(VAR) | Integer 16 Bit variable
+| DLT_INT16(VAR) | Integer 16 Bit variable
| DLT_INT32(VAR) | Integer 32 Bit variable
| DLT_INT64(VAR) | Integer 64 bit variable
| DLT_UINT(VAR) | Unsigned integer variable
-| DLT_UINT16(VAR) | Unsigned 16 Bit integer variable
+| DLT_UINT16(VAR) | Unsigned 16 Bit integer variable
| DLT_UINT32(VAR) | Unsigned 32 Bit integer variable
| DLT_UINT64(VAR) | Unsigned 64 bit integer variable
| DLT_BOOL(VAR) | Boolean variable
@@ -202,7 +202,7 @@ int main(int argc, const char\* argv\[\])
DLT_REGISTER_CONTEXT(myContext2,"TES2","Test Context 2 for Logging");
DLT_REGISTER_CONTEXT(myContext3,"TES3","Test Context 3 for Logging");
- DLT_UNREGISTER_CONTEXT(myContext1);
+ DLT_UNREGISTER_CONTEXT(myContext1);
DLT_UNREGISTER_CONTEXT(myContext2);
DLT_UNREGISTER_CONTEXT(myContext3);
@@ -240,12 +240,12 @@ int main()
DLT_LOG(myContext2,DLT_LOG_INFO,DLT_INT(5),DLT_STRING("But this only information"));
DLT_LOG(myContext3,DLT_LOG_DEBUG,DLT_INT(5),DLT_STRING("But this only information"));
- /* Sleep some time to avoid a flaw in dlt-daemon that would eat your messages
+ /* Sleep some time to avoid a flaw in dlt-daemon that would eat your messages
if you deregister while it still processes your registration */
sleep(3);
/* unregister your contexts */
- DLT_UNREGISTER_CONTEXT(myContext1);
+ DLT_UNREGISTER_CONTEXT(myContext1);
DLT_UNREGISTER_CONTEXT(myContext2);
DLT_UNREGISTER_CONTEXT(myContext3);
@@ -253,22 +253,22 @@ int main()
DLT_UNREGISTER_APP();
return 0;
-
+
}
----
.CMakeLists.txt
----
cmake_minimum_required(VERSION 2.6)
-
+
find_package(PkgConfig)
pkg_check_modules(DLT REQUIRED automotive-dlt)
-
+
include_directories("${DLT_INCLUDE_DIRS}")
-
+
project(DLTexample)
add_executable(dlt_example dlt_example.c)
-
+
target_link_libraries(dlt_example ${DLT_LIBRARIES})
----
diff --git a/doc/dlt_design_specification.txt b/doc/dlt_design_specification.txt
index 3e73af6..ce311d6 100644
--- a/doc/dlt_design_specification.txt
+++ b/doc/dlt_design_specification.txt
@@ -257,7 +257,7 @@ The following table shows, where the DLT messages are created. The message types
[options="header"]
|==============================================================================================
| Type of message | DLT client | DLT daemon | DLT library
-| Control request | X | X |
+| Control request | X | X |
| Control response | | X |
| Log message | | | X
| Trace message | | | X
@@ -544,7 +544,7 @@ The DLT daemon implementation uses the following files, besides DLT functions fr
[options="header"]
|==============================================================================================
-| File | Description
+| File | Description
| dlt-daemon.c | DLT daemon implementation
| dlt-daemon.h | Header file for dlt-daemon.c
| dlt-daemon_cfg.h | Compile time configuration for DLT daemon, Part1
@@ -570,18 +570,18 @@ The shared directory contains the following files:
|==============================================================================================
| File | Description
| dlt_common.c | Common helper functions, such as:
-- Print functions for DLT messages
+- Print functions for DLT messages
- Functions for handling DLT Ids
- Filter functions
- DLT message handling functions
-- Functions for handling DLT files
-- DLT receiver functions
-- Log handling
-- Ringbuffer functions
+- Functions for handling DLT files
+- DLT receiver functions
+- Log handling
+- Ringbuffer functions
- Setting and checking of storage header
| dlt_common_cfg.h | Compile time configuration for dlt_common.c
| dlt_user_shared.c | Shared functions, required by the DLT daemon and the DLT user library, such as:
-- Setting and checking the user header
+- Setting and checking the user header
- Sending DLT messages over named pipes (FIFOs)
| dlt_user_shared.h | Header file for dlt_user_shared.c
| dlt_user_shared_cfg.h | Compile time configuration for dlt_user_shared.c
@@ -613,7 +613,7 @@ The following important structures are used in the DLT Daemon and DLT User Libra
| DltDaemonApplication | Parameters of an application, used within DLT daemon
| DltDaemonContext | Parameters of a context, used within DLT daemon
| DltUserControlMsg... | User control messages
-| DltContext | Each context is represented with this structure
+| DltContext | Each context is represented with this structure
| DltContextData | Temorary used structure for constructing a log message
| DltUserInjectionCallback | One entry in dynamic callback table for callback function
| dlt_ll_ts_type | Table managing all contexts (and loglevels and trce statuses) within DLT user library, contains dynamicly growing array with "DltUserInjectionCallback" entries
diff --git a/doc/dlt_extended_network_trace.txt b/doc/dlt_extended_network_trace.txt
index ec1c9b3..42cdf92 100644
--- a/doc/dlt_extended_network_trace.txt
+++ b/doc/dlt_extended_network_trace.txt
@@ -15,13 +15,13 @@
Extended Network Trace
======================
-Lassi Marttala <Lassi.LM.Marttala@partner.bmw.de>
+Lassi Marttala <Lassi.LM.Marttala@partner.bmw.de>
0.0.1, 2012/10/11: Initial version
image::images/genivi_chrome_1_transparent.png[width=128]
== Introduction
-The extended network trace allows the user to send or truncate network trace messages
+The extended network trace allows the user to send or truncate network trace messages
that are larger than the normal maximum size of a DLT message.
== Protocol
@@ -56,7 +56,7 @@ User can send a segmented network trace message asynchronously using:
void dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload)
----
-This will start a background thread and return immediately.
+This will start a background thread and return immediately.
User can also send all the required packages one by one using:
diff --git a/doc/dlt_filetransfer.txt b/doc/dlt_filetransfer.txt
index 564b12a..1298c0e 100644
--- a/doc/dlt_filetransfer.txt
+++ b/doc/dlt_filetransfer.txt
@@ -22,13 +22,13 @@ image::images/genivi_chrome_1_transparent.png[width=128]
Overview
--------
-DLT is a reusable open source software component for standardized logging and tracing in infotainment ECUs based on the AUTOSAR 4.0 standard.
+DLT is a reusable open source software component for standardized logging and tracing in infotainment ECUs based on the AUTOSAR 4.0 standard.
The goal of DLT is the consolidation of the existing variety of logging and tracing protocols on one format.
Introduction to DLT Filetransfer
---------------------------------
-With DLT Filetransfer it is possible store the binary data of a file to the automotive dlt log.
+With DLT Filetransfer it is possible store the binary data of a file to the automotive dlt log.
The file will be read in binary mode and put as several chunks to a DLT_INFO log. With a special plugin of the dlt viewer, you can extract the embedded files from the trace and save them.
It can be used for smaller files, e.g. HMI screenshots or little coredumps.
@@ -178,7 +178,7 @@ There are two ways to use the filetransfer
* Automatic filetransfer in one step
* Header, data and end package order handeld by the user
-Automatic
+Automatic
~~~~~~~~~
Call
@@ -250,7 +250,7 @@ It's important that the dlt-filetransfer example files are installed in /usr/sha
* testFile1Run1
Test the file transfer with the condition that the transferred file is smaller as the file transfer buffer using dlt_user_log_file_complete.
* testFile1Run2
-Test the file transfer with the condition that the transferred file is smaller as the file transfer buffer using single package transfer
+Test the file transfer with the condition that the transferred file is smaller as the file transfer buffer using single package transfer
* testFile2Run1
Test the file transfer with the condition that the transferred file is bigger as the file transfer buffer using dlt_user_log_file_complete.
* testFile2Run2
diff --git a/doc/dlt_howto_debug.txt b/doc/dlt_howto_debug.txt
index 9ae9ed9..380f49b 100644
--- a/doc/dlt_howto_debug.txt
+++ b/doc/dlt_howto_debug.txt
@@ -15,7 +15,7 @@
How To - Debug DLT Daemon
=========================
-Lassi Marttala <Lassi.LM.Marttala@partner.bmw.de>
+Lassi Marttala <Lassi.LM.Marttala@partner.bmw.de>
0.0.1, 2013/03/18: Initial version
image::images/genivi_chrome_1_transparent.png[width=128]
@@ -32,7 +32,7 @@ The purpose is to provide the user with a clean working environment, where:
* dlt-daemon, library and all tools can be compiled from Eclipse UI without command line
* Debugger can be easily launched for any of the binaries in dlt-daemon project
-Anything in
+Anything in
----
code
----
@@ -72,7 +72,7 @@ Purpose: DLT utilizes cmake for build management.
----
sudo apt-get install git
----
-This will install git version control tool.
+This will install git version control tool.
Purpose: dlt-daemon version control is managed using git. Git is needed to clone the source code repository.
@@ -91,7 +91,7 @@ At the time of writing, _"Eclipse CDT Juno"_ was the latest version.
Extract the package to a directory. You should now have directory named "eclipse", which contains a binary called "eclipse". You should be able to start Eclipse by double clicking on the binary. In case there are problems, make sure you have proper permissions for the directory, sub-directories and that the binary has "executable"-flag set.
----
-chmod u+x eclipse
+chmod u+x eclipse
----
if required.
@@ -129,7 +129,7 @@ If these commands succeeded, you can continue. If there were errors, please reme
Clean up the git directory. The following command will delete all files that are not part of the repository. Please use caution.
----
-git clean -fdx
+git clean -fdx
----
Now you have a working source directory. We can proceed to setting up the Eclipse project.
@@ -147,7 +147,7 @@ image:images/eclipse-create-c-project.png[]
Name the project _"dlt-daemon"_.
-Select: _"Makefile project -> Empty Project"_ from the left and _"-- Other Toolchain --"_ from the right.
+Select: _"Makefile project -> Empty Project"_ from the left and _"-- Other Toolchain --"_ from the right.
Make a note of the project location. This will be know *DLT_PROJECT_DIR* from now on in this document.
@@ -229,11 +229,11 @@ In the following dialog, select _"General -> File system"_ and *click* _"Next"_
image:images/eclipse-import-links.png[]
-*Click* _"Browse"_ and navigate to your DLT_GIT_DIR.
+*Click* _"Browse"_ and navigate to your DLT_GIT_DIR.
-*Check* _"dlt-daemon"_ root directory.
+*Check* _"dlt-daemon"_ root directory.
-*Click* _"Advanced"_ and *Check* _"Create links"_ and _"Create virtual folders"_.
+*Click* _"Advanced"_ and *Check* _"Create links"_ and _"Create virtual folders"_.
*Click* _"Filter types..."_ and only check the file types you want to see _"*.c, *.h"_ is sufficient for most cases.
diff --git a/doc/dlt_user_manual.txt b/doc/dlt_user_manual.txt
index 2d16509..f8938d0 100644
--- a/doc/dlt_user_manual.txt
+++ b/doc/dlt_user_manual.txt
@@ -219,12 +219,12 @@ DLT_REGISTER_CONTEXT(mycontext,"TEST","Test Context for Logging");
}
----
-.Important notes:
+.Important notes:
* If your application uses fork(), you may not call DLT_REGISTER_APP before fork(). And fork() should never be called after DLT_REGISTER_APP. This is because of state information and inter process communication channel to daemon would be copied to new process, but threads would be not.
* DLT_REGISTER_APP is asynchronous. It may take some milliseconds to establish the IPC channel. Because of this, you might lose messages if you log immediately after registering. Typically this is not a problem, but may arise especially with simple examples.
==== Use one of the DLT macros or the DLT function interface:
-Here we use the macro interface of DLT.
+Here we use the macro interface of DLT.
----
DLT_LOG(mycontext,DLT_LOG_WARN,DLT_INT(5),DLT_STRING("This is a warning"));
@@ -305,7 +305,7 @@ The DLT functional interface provides a very easy to use interface. The C interf
[options="header"]
|==============================================================================================
| Command | Description
-| #include <dlt/dlt.h> | The first thing to do is to include the standard header file of DLT:
+| #include <dlt/dlt.h> | The first thing to do is to include the standard header file of DLT:
| DltContext mycontext; | The next thing is to create an instance of each used context of an application. This has to be done outside of the source code before using any context. The name of the instance can be defined by the user.
| DltContextData mycontextdata; | Additionally, a data buffer used to construct the DLT log messages must be created:
| dlt_register_app("LOG","Test Application for Logging"); | In the next step in the initialization of the application the application must be registered in the DLT daemon. The identifier of the application, here "LOG", has a maximum of four characters.
@@ -314,16 +314,16 @@ The DLT functional interface provides a very easy to use interface. The C interf
| | Choose now between verbose mode and non-verbose mode:
| dlt_verbose_mode(); | For verbose mode (default): Optionally switch to verbose mode by calling the function dlt_verbose_mode:
| if (dlt_user_log_write_start(&mycontext,&mycontextdata,DLT_LOG_WARN))
-{
- dlt_user_log_write_int(&mycontextdata,num);
+{
+ dlt_user_log_write_int(&mycontextdata,num);
dlt_user_log_write_string(&mycontextdata,text);
- dlt_user_log_write_finish(&mycontextdata);
+ dlt_user_log_write_finish(&mycontextdata);
} | After registration a context can be used to send log messages to the DLT daemon. The dlt_user_log_write function has to be called first with a pointer to the context, a pointer to the data buffer and the used log level of the log messages. For each parameter added to the DLT log message a call to dlt_user_log_write_xxx has to be done. A complete list of parameters you will find in the Addendum API specification. Sending of the DLT message is done by calling dlt_user_log_write_finish.
| dlt_log_int(&mycontext, DLT_LOG_WARN, num); dlt_log_string_int(&mycontext, DLT_LOG_WARN, text, num); | As an alternative, the high level logging functions can be used which exists for special combination of parameters. A complete list you will find in the Addendum API specification.
| dlt_nonverbose_mode(); | For non-verbose mode : Switch to non-verbose mode by calling the function dlt_nonverbose_mode:
| if (dlt_user_log_write_start_id(&mycontext,&mycontextdata,DLT_LOG_WARN,msgid))
-{
- dlt_user_log_write_int(&mycontextdata,num);
+{
+ dlt_user_log_write_int(&mycontextdata,num);
dlt_user_log_write_string(&mycontextdata,text);
dlt_user_log_write_finish(&mycontextdata);
} | After registration a context can be used to send log messages to the DLT daemon. The dlt_user_log_write_start_id function has to be called first with a pointer to the context, a pointer to the context data, the used log level of the log messages and the message id. For each parameter added to the DLT log message a call to dlt_user_log_write_xxx has to be done. A complete list of parameters you will find in the Addendum API specification. Sending of the DLT message is done by calling dlt_user_log_write_finish.
diff --git a/doc/doxygen.cfg.cmake b/doc/doxygen.cfg.cmake
index f14479c..5c17864 100755
--- a/doc/doxygen.cfg.cmake
+++ b/doc/doxygen.cfg.cmake
@@ -591,7 +591,7 @@ WARN_LOGFILE =
# with spaces.
INPUT = @CMAKE_SOURCE_DIR@/doc/mainpage.h \
- @CMAKE_SOURCE_DIR@/src/ \
+ @CMAKE_SOURCE_DIR@/src/ \
@CMAKE_SOURCE_DIR@/include
@@ -626,7 +626,7 @@ FILE_PATTERNS = *.c \
*.hh \
*.hxx \
*.hpp \
- *.h++
+ *.h++
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
diff --git a/doc/extended_network_trace_doxygen.cfg.cmake b/doc/extended_network_trace_doxygen.cfg.cmake
index 9cf51cc..adefc59 100755
--- a/doc/extended_network_trace_doxygen.cfg.cmake
+++ b/doc/extended_network_trace_doxygen.cfg.cmake
@@ -625,7 +625,7 @@ FILE_PATTERNS = *.c \
*.hh \
*.hxx \
*.hpp \
- *.h++
+ *.h++
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
@@ -1378,7 +1378,7 @@ HIDE_UNDOC_RELATIONS = YES
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
-HAVE_DOT =
+HAVE_DOT =
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
diff --git a/doc/mainpage.h b/doc/mainpage.h
index 34bc861..82648e3 100644
--- a/doc/mainpage.h
+++ b/doc/mainpage.h
@@ -26,7 +26,7 @@ License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/.
can be found at http://projects.genivi.org/diagnostic-log-trace/ \n
\par About DLT
-DLT is a reusable open source software component for standardized logging and tracing in infotainment ECUs based on the AUTOSAR 4.0 standard.
+DLT is a reusable open source software component for standardized logging and tracing in infotainment ECUs based on the AUTOSAR 4.0 standard.
The goal of DLT is the consolidation of the existing variety of logging and tracing protocols on one format.