diff options
| author | thanhbnq <49302843+thanhbnq@users.noreply.github.com> | 2019-04-16 14:52:52 +0700 |
|---|---|---|
| committer | Saya Sugiura <39760799+ssugiura@users.noreply.github.com> | 2019-04-16 16:52:52 +0900 |
| commit | 5d21bc4858c7d0d67adb1e0cdec9880d97b83567 (patch) | |
| tree | 7ff7f2e5bb6ebf3c2d51e5e3eb2a08df2449aaef /README.md | |
| parent | 376bf6c1750d8d1c6bb1a5abc73e5b081d7b7825 (diff) | |
| download | DLT-daemon-5d21bc4858c7d0d67adb1e0cdec9880d97b83567.tar.gz | |
doc: Update doc/CMakeList.txt after cleanup documentation (#111) (#117)
* 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>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 8 insertions, 8 deletions
@@ -28,7 +28,7 @@ The following packages need to be installed in order to be able to build and ins On Ubuntu those dependencies can be installed with the following command: -> sudo apt-get install cmake zlib1g-dev libdbus-glib-1-dev +`sudo apt-get install cmake zlib1g-dev libdbus-glib-1-dev` To build and install the DLT daemon, follow these steps: @@ -129,9 +129,9 @@ All text based documentation will be replaced with by Markdown-based documentati Old documentation (not maintained - will be removed in future releases): -- DLT User Manual: doc/dlt_user_manual.txt +- DLT User Manual: doc/dlt\_user\_manual.txt - DLT Cheatsheet: doc/dlt_cheatsheet.txt -- DLT Design Specification: doc/dlt_design_specification.txt +- DLT Design Specification: doc/dlt\_design\_specification.txt - DLT Compilation of all documentation: doc/dlt_book.txt ### API Documentation @@ -164,8 +164,8 @@ If the man pages are changed the following command must be executed. ```bash mkdir build cd build -cmake -DWITH_DOC=ON .. -make doc-man +cmake -DWITH_MAN=ON .. +make generate_man ``` The generated man pages overwrite the existing ones. @@ -187,8 +187,8 @@ uncrustify version: 0.68_f List of open issues can be found on [Github](https://github.com/GENIVI/dlt-daemon/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. +- 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. - For Non linux platforms [eg: QNX] IPC supported is UNIX_SOCKET. For Linux Platforms both IPC FIFO and UNIX_SOCKET are supported ## Software/Hardware @@ -198,7 +198,7 @@ Developed and tested with Ubuntu Linux 16 64-bit / Intel PC ## License Full information on the license for this software is available in the "LICENSE" file. -Full information on the license for the cityhash code is available in "COPYING" file in src/core_dump_handler/cityhash_c. +Full information on the license for the cityhash code is available in "COPYING" file in src/core\_dump\_handler/cityhash_c. ## Mailinglist |