summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: Minor fix in dlt_for_developers.md (#321)kenji-hosokawa2021-07-151-8/+7
| | | | | | | | * doc: remove non existing TOC TOC has Summary, but nothing in the body. Remove it from TOC. Signed-off-by: Kenji Hosokawa <khosokawa@jp.adit-jv.com>
* Extend include path in *.pc file (#319)Martin Willers2021-07-151-5/+7
| | | | | | | | | | | | | | | | | | | | * Extend include path in *.pc file Previously, an application using this library's pkg-config setting for include directory would only get e.g. -I/usr/local/dlt/include/dlt With that include dir, the application needs to write its #include statements without any prefix, i.e. "#include "dlt_user.h" This is considered bad practice for header files of an elaborate library consisting of multiple header files. For such libraries, one should write #include statements like this: #include "dlt/dlt_user.h", i.e. prefix it with a directory. This commit achieves that by letting the pkg-config module also return the upper-level directory in addition to the previous one. For instance, the include directive returned by the above example would now be "-I/usr/local/dlt/include -I/usr/local/dlt". Signed-off-by: Martin Willers <M.Willers@gmx.net>
* Update document and fix conversion warningDinh Cong Toan2021-06-301-1/+1
| | | | Signed-off-by: Dinh Cong Toan <toan.dinhcong@vn.bosch.com>
* Update dlt-system.conf documentationDinh Cong Toan2021-06-301-2/+2
| | | | | | Adding configuration of syslog to forward log into specific port. Signed-off-by: Dinh Cong Toan <toan.dinhcong@vn.bosch.com>
* dlt-doc:Fix generating HTML documentation and man pagesdbiastoch2021-06-301-113/+66
| | | | | | | | | | | | | HTML documentation: -Implemented GLOB mechanism to get all md files inside '/doc' for generating html documentation -Replacing all markdown links in generated html files with the corresponding html links (using sed) -Bug fixes +Marking Doxygen as required package to get a nice error message, if it's missing +'cp' needs '-r' argument, because it includes another subdirectory with images Man Pages: -Also make use of GLOB and foreach loops to get rid of hardcoded filenames Signed-off-by: dbiastoch <dbiastoch@de.adit-jv.com>
* dlt-receive: Enabled more filtering by using json filter filesdbiastoch2021-06-302-2/+42
| | | | | | | | | | | | | | | -Added '-j' flag to dlt-receive for reading a json filter file -Added more attributes to DltFilter (LogLevel, MaxPayload, MinPayload) for extended message filtering, when using old filters these values are set to default. Same behaviour, when they are not defined in json filter file. -extended dlt_common.c to support json filter files and new DltFilter attributes +add dlt_json_filter_load to parse a json filter file into a DltFilter +add dlt_json_filter_save to print a DltFilter into a json file -Two new libraries are used to parse the json filter files: json-c for Linux based systems and the QNX internal libjson for QNX systems -gtest_dlt_common was modified to test the new function 'dlt_json_filter_load' +add testfile_extended.dlt that contains a bigger varity of messages (different context/app IDs, lengths and log levels) +add testfilter.json which is a valid json filter file -New dependency on library was added to related CMakeLists and is described in README.md Signed-off-by: dbiastoch <dbiastoch@de.adit-jv.com>
* Add missing string functions (#309)Martin Willers2021-05-311-2/+2
| | | Signed-off-by: Martin Willers <M.Willers@gmx.net>
* Make nonverbose mode non exclusive (#300)Martin Willers2021-05-171-18/+30
| | | | | | | | | | | | | | | | * Make Non-Verbose mode non-exclusive Switching to global Non-Verbose mode now does not force Verbose messages to also be sent as Non-Verbose ones anymore. That would not make any sense, because Verbose messages don't have a MessageId and thus are all getting the same MessageId of 65535. Instead, setting global "Non-Verbose" mode will allow both Verbose and Non-Verbose messages to be sent in a single session. The "Verbose-APIs" (e.g. dlt_user_log_write_start()) will then only write Verbose messages, whereas the "Non-Verbose APIs" (e.g. dlt_user_log_write_start_id()) will then only write Non-Verbose messages. Signed-off-by: Martin Willers <M.Willers@gmx.net>
* Export cmake config file (#289)Martin Willers2021-05-101-4/+65
| | | | | | | | | | | | | | Create and install proper CMake *-target.cmake and *-config.cmake files, for use by other CMake-using projects. It installs a file called automotive-dlt-targets.cmake into a common location for such files, namely <prefix>/lib/cmake/automotive-dlt/automotive-dlt-targets.cmake They can now call find_package(automotive-dlt) and obtain a target called Genivi::dlt that they can link against with target_link_libraries(), by which they automatically gain all necessary attributes, including libdlt's include directories. Signed-off-by: Martin Willers <M.Willers@gmx.net>
* dlt-receive: Add option to configure port of dlt receive (#293)Alex2021-03-161-1/+4
| | | Signed-off-by: Alexander Mohr <git@mohr.io>
* Add verbose mode attribute handling (#292)Martin Willers2021-03-161-0/+33
| | | | | | dlt_user_log_write_*_attr() enables to writing these types, but also support adding "attributes" for them, i.e. a "name" and a "unit". Signed-off-by: Martin Willers <M.Willers@gmx.net>
* doc: Limitation to SIGUSR1 usage on AndroidSaya Sugiura2021-01-062-0/+12
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* example: Added customization of CxtID and AppIDdbiastoch2021-01-061-0/+106
| | | | | | | | -It's now possbile to enter a custom app and context ID by using the new implemented "-A" and "-C" arguments. -Also added a markdown manual in the doc directory for dlt-example-user. Signed-off-by: dbiastoch <dbiastoch@de.adit-jv.com>
* doc: Update doc for the maintain logstorage loglevel implementationKHANH LUONG HONG DUY2021-01-061-1/+24
| | | | Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* design doc: update spec for new environment variableBui Nguyen Quoc Thanh2021-01-061-0/+6
| | | | Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* doc: update disable injection msg for developerBui Nguyen Quoc Thanh2021-01-061-0/+16
| | | | Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* doc: Rewrote the DLT user documentation.Sebastian Unger2021-01-063-0/+171
| | | | | | | | - Write introduction and prepare new TOC - Intro to Get Started, instructions on how to download and detailed TOC further - Started Run DLT Demo section Signed-off-by: Sebastian Unger <sunger@de.adit-jv.com>
* Add support for logging with VSOCK (#255)Martin Ejdestig2020-12-141-8/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For more information about VSOCK, see "man vsock" ( https://man7.org/linux/man-pages/man7/vsock.7.html ). Makes it possible for processes in a virtual machine to log directly in DLT running on host without setting up a network connection between guest and host. It is also probably more efficient. Have not done any performance measurements (not main reason for patch), but no forwarding is required as when running DLT in a multi-node setup. When building dlt-daemon for host, WITH_DLT_DAEMON_VSOCK_IPC should be enabled for daemon to listen on incoming VSOCK requests. Local communication method between applications and daemon is still determined with DLT_IPC. When building for guest, WITH_DLT_LIB_VSOCK_IPC should be enabled and DLT_IPC will be ignored, which will make libdlt open a VSOCK socket to the deamon for logging messages. VSOCK can be tested without a virtual machine. Since VMADDR_CID_HOST is used by libdlt when connecting, see vsock man page, clients can be run on host to test VSOCK communication. Some modifications has been done to be able to handle logging through FIFO pipe and socket in the same build of dlt-daemon: - dlt_receiver_init/free_unix_socket() is renamed to dlt_receiver_init/free_global_buffer() and used for FIFO as well. Also fixes memory leak since dlt_receiver_free_unix_socket() was used regardless of whether DLT_USE_UNIX_SOCKET was defined or not. - Pass type to dlt_receiver_init() instead of dlt_receiver_receive(). And remove preprocessor conditionals for handling DLT_CONNECTION_APP_MSG in dlt_daemon_process_user_messages(). Also fixes wrong enum type being passed to dlt_receiver_receive() in dlt_client.c (DltClient::mode was used as a DltReceiverType enum but it is a DltClientMode enum). - Add a flag to DltDaemonApplication to indicate whether file descriptor is "owned" by the DltDaemonApplication or not. When dlt_daemon_application_add() is called due to message received on a socket, fd is passed as an argument (app does not own fd). For FIFO, a per application FIFO is opened (app owns the fd). Also fixes so that user handle is reset for both application and all its contexts when resetting any. Prevents fd from being used by accident after it has been closed. dlt_mkdir_recursive() is moved to src/daemon since it is only used in the daemon. Minimizes use of DLT_USE_UNIX_SOCKET_IPC. Other bugfixes: - Call DLT_SEM_FREE() if setting socket to O_NONBLOCK fails in src/lib/dlt_user.c:dlt_initialize_socket_connection(). - Close socket if dlt_receiver_init() fails in src/lib/dlt_user.c:dlt_initialize_socket_connection(). Signed-off-by: Martin Ejdestig <martin.ejdestig@volvocars.com>
* dlt-daemon: Adds an option to disable injection mode (#266)sebastienr2020-11-251-0/+6
| | | | | | A new option named "InjectionMode" allows to select if we want to enable / disable the feature Signed-off-by: Sebastien RAILLET <sebastien.raillet@marelli.com>
* slog2 adapter on QNXNguyen Dinh Thi2020-07-081-0/+102
| | | | | | | | | | | | | | | dlt-qnx-system can be used to send syslog on QNX to dlt-daemon using slog2 API. It was be built with setting cmake option WITH_DLT_QNX_SYSTEM to ON. Add markdown manual page for dlt-qnx-system Signed-off-by: Nguyen Dinh Thi (RBVH/ENG2) <Thi.NguyenDinh@vn.bosch.com> Signed-off-by: Le Hoang Ngoc Quynh <Quynh.LeHoangNgoc@vn.bosch.com> Signed-off-by: Sebastian Unger <sunger@de.adit-jv.com> Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com> Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com> Signed-off-by: Felix Herrmann <fherrmann@de.adit-jv.com>
* doc/CMakeList.txt: replace dlt_design_specification.txt to .mdKHANH LUONG HONG DUY2020-07-061-1/+1
| | | | Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* remove unused featureKHANH LUONG HONG DUY2020-07-061-4/+0
| | | | Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* set DLT_NETWORK_TRACE_ENABLE by cmakedefineFelix Herrmann2020-07-061-0/+3
| | | | | Signed-off-by: Felix Herrmann <fherrmann@de.adit-jv.com> Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* doc: Update dlt_offline_logstorage.mdBui Nguyen Quoc Thanh2020-07-061-0/+1
| | | | | | | Add note/recommendation for the case multiple FILTERs use the same value for `File` setting. Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* dlt_design_specification: update contentLUONG HONG DUY KHANH(RBVH/ENG42)2020-07-063-125/+314
| | | | Signed-off-by: LUONG HONG DUY KHANH(RBVH/ENG42) <KHANH.LUONGHONGDUY@vn.bosch.com>
* dlt_design_specification: convert from .txt to .md formatLUONG HONG DUY KHANH(RBVH/ENG42)2020-07-062-644/+622
| | | | Signed-off-by: LUONG HONG DUY KHANH(RBVH/ENG42) <KHANH.LUONGHONGDUY@vn.bosch.com>
* doc: md file for dlt_gateway.confBui Nguyen Quoc Thanh2020-07-063-24/+135
| | | | Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* network trace: Add mqueue verificationSaya Sugiura2020-07-061-1/+7
| | | | | | | | | | There is some OS (e.g. Android) which doesn't support message queue. Since network trace uses it as IPC, we need to disable it if following calls are not available: mq_open, mq_close, mq_unlink, mq_send, mq_receive Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com> Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* Redirect stdout to stderrLUONG HONG DUY KHANH(RBVH/ENG42)2020-07-061-1/+1
| | | | | | | | | | | | - daemon: New feature for LoggingMode at /etc/dlt.conf to be able to set value at 3 in order to redirect all stdout messages to stderr. - libdlt: New feature for DLT_LOG_MODE environment variable to be able to set value at 3 in order to redirect all stdout messages to stderr. - unit test: Add test cases for DLT_LOG_TO_STDERR Signed-off-by: LUONG HONG DUY KHANH(RBVH/ENG42) <KHANH.LUONGHONGDUY@vn.bosch.com>
* doc: update a note for logstorage with wildcardBui Nguyen Quoc Thanh2020-07-061-0/+3
| | | | | | | If both of the parameter "LogAppName" and "ContextName" are set to wildcard or not present in the configuration file, "EcuID" must be specified. Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* doc: Logstorage non-verbose filterSaya Sugiura2020-07-061-1/+39
| | | | | | Add explanation and example to non-verbose filter. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* Add documentation for new sized string functionsMartin Willers2020-05-181-2/+34
| | | | Signed-off-by: Martin Willers <M.Willers@gmx.net>
* doc/dlt_for_developers.md: Fix wrong DLT include directiveSebastian Lipponer2020-02-111-1/+1
| | | | | | | | | | | | The include directive '#include <dlt/dlt.h>' that is stated in the developer guide (see 'doc/dlt_for_developers.md') does not work when the include path is set via the pkg-config file 'automotive-dlt.pc'. The include path set via this file requires users to use the include directive '#include <dlt.h>'. This is also in accordance with older DLT documentation. Signed-off-by: Sebastian Lipponer <mail@sebastianlipponer.de>
* Provide DLT_GET_APPID macro (#187) (#188)Vo Trung Chi2019-11-141-0/+19
| | | Signed-off-by: Christoph Lipka <clipka@jp.adit-jv.com>
* libdlt: reattachment and improvement in dlt thread (#171)Vo Trung Chi2019-10-011-1/+1
| | | | | | | | | | | | | | | | | Improvement: housekeeper thread with poll - Change name receiver thread to housekeeper thread - Use poll() in housekeeper thread to get new received message from DLT Daemon. - Remove resend buffer inside of dlt_user_log_reattach_to_daemon() - Only try to resend buffer if fd is valid. This commit removes the event driven dlt_user_log_reattach_to_daemon() that is called e.g. by DLT_LOG. Now, only the DLT housekeeper thread handles the retrial to attach to daemon. Signed-off-by: Vo Trung Chi <Chi.VoTrung@vn.bosch.com> Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com> Signed-off-by: Simon Herkenhoff <sherkenhoff@jp.adit-jv.com> Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* Update cmakelist, fix build due to copy-paste error (#170)Gianfranco Costamagna2019-09-231-1/+1
| | | | | | dlt-control should generate a dlt-control manpage, not a dlt-system one Signed-off-by: Gianfranco Costamagna <costamagnagianfranco@yahoo.it> Signed-off-by: Gianfranco Costamagna <locutusofborg@debian.org>
* doc: Modify markdown doc generationSaya Sugiura2019-09-131-21/+9
| | | | | | Use pandoc to generate html from markdown. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Update dlt_for_developers.mdBui Nguyen Quoc Thanh2019-09-131-12/+24
| | | | | | | - Add instructions how to use wildcard with DLT_INITIAL_LOG_LEVEL - Correct the wrong display with underscore in markdown file. Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* console: Tool to merge multiple DLT filesBui Nguyen Quoc Thanh2019-09-132-8/+13
| | | | | | | | | | | | | | - Sort in dlt-sortbytimestamp: first sorted by time, second sorted by timestamp. - Support multiple compressed files in dlt-convert. These changes is based on use case: User can expects to join several dlt files which are compressed in tar.gz file (maybe per component). Moreover, currently the existing sort is only applicaple for single boot cycle. There should be a support for sorting multiple cyclic boots in one dlt file. Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* Add user custom timestamp interfaceSebastian Unger2019-09-131-0/+31
| | | | | | | | | | | | | Two new macros are introduced so that users can use their customized timestamps for DLT messages: - DLT_LOG_TS(CONTEXT, LOGLEVEL, TS, ARGS ...) - DLT_LOG_ID_TS(CONTEXT, LOGLEVEL, MSGID, TS, ARGS ...) Detailed explanations can be found in dlt_for_developers.md. Also a new option is added to dlt-system to use events' timestamps from journald adapter. Signed-off-by: Sebastian Unger <sunger@de.adit-jv.com>
* UDP Multicast implementation (#155)Sunil-K-S2019-08-231-0/+12
| | | | | The feature can be enabled by setting WITH_UDP_CONNECTION to ON. Signed-off-by: sunil.s <sunil.s@lge.com>
* doc: Remove unused imagesSaya Sugiura2019-08-0715-2/+2
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* Add option to set owner group of daemon FIFO (#122)Jiri Popek2019-07-251-0/+44
| | | | | | | | | | New option to set owner group of daemon FIFO (Default: /tmp/dlt) is added in dlt.conf. If this option is used properly, more secure tracing can be realized. Only application that is in dlt_user_apps_group can write log message to daemon FIFO. Signed-off-by: Yusuke Sato <yusuke-sato@apn.alpine.co.jp>
* doxygen: Align variable for apid and ctidSaya Sugiura2019-07-191-6/+6
| | | | | | | The variables used for application id and context id are aligned with "apid" and "ctid". Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doxygen: Remove licenceSaya Sugiura2019-07-194-8/+0
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doxygen: Get rid of warningsSaya Sugiura2019-07-191-1/+1
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Use pandoc to generate HTML from markdownSaya Sugiura2019-07-191-0/+26
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Create missing markdown documentsSaya Sugiura2019-07-194-5/+312
| | | | | | | | | Following documents are created: - dlt-control.1.md - dlt-adaptor-stdin.1.md - dlt-adaptor-udp.1.md Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Documentation updateSaya Sugiura2019-07-197-1141/+80
| | | | | | | | | | | | | | | | As written in README, following documents are removed and necessary information is moved to dlt_for_developers.md: - doc/dlt_user_manual.txt - doc/dlt_cheatsheet.txt - doc/dlt_book.txt Also following documents are removed: - doc/dlt_howto_debug.txt - doc/dlt_loglevel_explained.txt TODO: Update doc/dlt_design_specification.txt Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* cmake: Allow build as a subproject (#145)Vo Trung Chi2019-07-093-19/+19
| | | | | | Use PROJECT_* instead of CMAKE_* to allow build as a subproject of another cmake project. Signed-off-by: Vo Trung Chi <Chi.VoTrung@vn.bosch.com>
View Lorry Controller Status