summaryrefslogtreecommitdiff
path: root/doc/dlt_for_developers.md
Commit message (Collapse)AuthorAgeFilesLines
* Make the legacy include path a CMake option (#332)Martin Willers2021-10-051-2/+9
| | | Signed-off-by: Martin Willers <M.Willers@gmx.net>
* libdlt: Add legacy include path in exported CMake config file (#327)Sebastian Lipponer2021-09-141-6/+2
| | | | | | | | | | | | | Previously the generated .pc file was changed to export an additional include path such that '#include <dlt.h>' and '#include <dlt/dlt.h>' can be used. However the exported CMake config file only supports the latter include statement. Consequently code that uses the other legacy include statement does not compile with the exported CMake config file. This change fixes this inconsistency. It lets users compile existing code with either the pkg-config .pc file or the CMake config file and avoids code clutter that is currently necessary to make this work. Signed-off-by: Sebastian Lipponer <mail@sebastianlipponer.de>
* 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>
* 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>
* 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-061-0/+5
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.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>
* 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>
* 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>
* 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>
* 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>
* doxygen: Get rid of warningsSaya Sugiura2019-07-191-1/+1
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Documentation updateSaya Sugiura2019-07-191-2/+72
| | | | | | | | | | | | | | | | 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>
* doc: Improve dlt_for_developers.mdSaya Sugiura2019-06-251-122/+255
| | | | | | | This includes improvement of markdown formatting as well as changes in description itself. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Update doc/CMakeList.txt after cleanup documentation (#111) (#117)thanhbnq2019-04-161-1/+0
| | | | | | | | | | * doc: Update after cleanup documentation - Add ascii_doc check - Spaces instead of tabs in doc/CMakeList.txt - Change style in markdown files to avoid error while converting from md to html - Since manpages are generated by pandoc, "doc-man" part is removed from doc/CMakeList.txt Signed-off-by: thanhbnq <thanh.buinguyenquoc@vn.bosch.vn>
* doc: Raise an awareness of log level syncBui Nguyen Quoc Thanh2019-03-261-0/+2
| | | | | | | Raise an awareness of log level synchronization between DLT Daemon and application after registrations. Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* doc: Move all man pages to markdown files (#102)v2.18.1Christoph Lipka2019-02-121-79/+131
| | | | All manpages have been removed, because they will be autogenerated from markdown files using pandoc.
* fix broken/missing links in documentationChristoph Lipka2018-12-211-0/+2
| | | | Signed-off-by: Christoph Lipka <clipka@de.adit-jv.com>
* Documentation updateChristoph Lipka2018-12-211-0/+426
Signed-off-by: Manikandan C <mchockalingam@de.adit-jv.com> Signed-off-by: Christoph Lipka <clipka@de.adit-jv.com>
View Lorry Controller Status