diff options
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 106 |
1 files changed, 70 insertions, 36 deletions
@@ -18,46 +18,46 @@ Compile options with default values ----------------------------------- [options="header"] |============================================================================================== -| Option | Value | Comment -| WITH_SYSTEMD | OFF | Set to on to run CMakeLists.txt in systemd -| WITH_SYSTEMD_WATCHDOG | OFF | Set to ON to use the systemd watchdog in dlt-daemon -| WITH_DLT_ADAPTOR | ON | Set ton ON to build src/adaptor binaries -| WITH_DLT_CONSOLE | ON | Set ton ON to build src/console binaries -| WITH_DLT_SYSTEM | ON | Set ton ON to build src/systembinaries -| WITH_DLT_EXAMPLES | ON | Set ton ON to build src/examplesbinaries -| WITH_DLT_TESTS | ON | Set ton ON to build src/testbinaries -| WITH_DLT_SHM_ENABLE | OFF | Set to OFF to use FIFO as IPC from user to daemon -| WITH_CHECK_CONFIG_FILE | OFF | Set to ON to create a configure file of CheckIncludeFiles and CheckFunctionExists -| WITH_DOC | OFF | Set to ON to build documentation target -| WITH_TESTSCRIPTS | OFF | Set to on to run CMakeLists.txt in test scripts -| WITH_GPROF | OFF | Set \-pg to compile flags -| WITH_MAN | ON | Set to OFF to skip building of man pages -| BUILD_SHARED_LIBS | ON | Set to OFF to build static libraries -| CMAKE_INSTALL_PREFIX | /usr/local | -| CMAKE_BUILD_TYPE | RelWithDebInfo | +| Option | Value | Comment +| BUILD_SHARED_LIBS | ON | Set to OFF to build static libraries +| WITH_SYSTEMD | OFF | Set to ON to run CMakeLists.txt in systemd +| WITH_SYSTEMD_WATCHDOG | OFF | Set to ON to use the systemd watchdog in dlt-daemon +| WITH_SYSTEMD_JOURNAL | OFF | Set to ON to use the systemd journal in dlt-system +| WITH_DOC | OFF | Set to ON to build documentation target +| WITH_MAN | ON | Set to OFF to skip building of man pages +| WITH_CHECK_CONFIG_FILE | OFF | Set to ON to create a configure file of CheckIncludeFiles and CheckFunctionExists +| WITH_TESTSCRIPTS | OFF | Set to ON to run CMakeLists.txt in test scripts +| WITH_GPROF | OFF | Set \-pg to compile flags +| WITH_DLTTEST | OFF | Set to ON to build with modifications to test User-Daemon communication with corrupt messages +| WITH_DLT_SHM_ENABLE | OFF | Set to OFF to use FIFO as IPC from user to daemon +| WITH_DLT_ADAPTOR | ON | Set to ON to build src/adaptor binaries +| WITH_DLT_CONSOLE | ON | Set to ON to build src/console binaries +| WITH_DLT_EXAMPLES | ON | Set to ON to build src/examples binaries +| WITH_DLT_SYSTEM | ON | Set to ON to build src/system binaries +| WITH_DLT_DBUS | ON | Set to ON to build src/dbus binaries +| WITH_DLT_TESTS | ON | Set to ON to build src/test binaries +| WITH_DLT_CXX11_EXT | OFF | Set to ON to build C++11 extensions +| WITH_DLT_COREDUMPHANDLER | OFF | EXPERIMENTAL! Set to ON to build src/core_dump_handler binaries. EXPERIMENTAL +| WITH_DLT_LOGSTORAGE_CTRL_UDEV | OFF | PROTOTYPE! Set to ON to build logstorage control application with udev support +| WITH_DLT_LOGSTORAGE_CTRL_PROP | OFF | PROTOTYPE! Set to ON to build logstorage control application with proprietary support +| WITH_DLT_USE_IPv6 | ON | Set to ON for IPv6 support +| WITH_DLT_KPI | ON | Set to ON to build src/kpi binaries +| CMAKE_INSTALL_PREFIX | /usr/local | +| CMAKE_BUILD_TYPE | RelWithDebInfo | |============================================================================================== -In order to change these options, you can modify this values +In order to change these options, you can modify these 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 +- Example: cmake -DWITH_SYSTEMD=ON -DWITH_SYSTEMD_JOURNAL=ON -DCMAKE_INSTALL_PREFIX=/usr .. Create Man pages ---------------- -The man pages are generated with following commands. -They are generated by default (WITH_MAN=ON). +The man pages are generated and installed during the standard build and install. ----- -mkdir build -cd build -cmake .. -make -sudo make install ----- - -You will find the man pages after installation in <CMAKE_INSTALL_PREFIX>/share/man. +After installation they are located in <CMAKE_INSTALL_PREFIX>/share/man. The man pages are generated with asciidoc. If the man pages are changed the following command must be executed. @@ -69,7 +69,7 @@ cmake -DWITH_DOC=ON .. make doc-man ---- -The generated man pages overwrites the existing ones. +The generated man pages overwrite the existing ones. Create manuals documentation ---------------------------- @@ -99,16 +99,16 @@ You will find the generated documents in build/doc/DOC_DLT. Generation of systemd unit files -------------------------------- -DLT provides some example unit files for systemd, stored in <DLT-root>/systemd. -In <DLT-root>/systemd/CMakeLists.txt you have to specify some values, e.g. the port for dlt-adaptor-udp. -By default the generation of unit files with cmake is off. Please follow these steps to enable the generation: +DLT provides cmake files to create unit files for systemd. These can be found in the systemd directory. +In systemd/CMakeLists.txt you can modify some values, e.g. the port for dlt-adaptor-udp. +By default the generation of unit files with cmake is disabled. Please follow these steps to enable the generation: * Change into the root directory of DLT-daemon * mkdir build * cd build * cmake -DWITH_SYSTEMD=ON .. -You find the parsed unit files in the PROJECT_BINARY_DIR/systemd directory. +You find the generated unit files in build/systemd. They are installed in ${CMAKE_INSTALL_PREFIX}/lib/systemd/system when make install is run. Git configuration ----------------- @@ -160,6 +160,40 @@ If you want to commit your changes, send them to the auto-dlt list, you can crea git format-patch -s <remote branch> ---- -This creates a set of patches that are published via the mailing list. The patches will be discussed, merged & uploaded on the git. +This creates a set of patches (one patch per commit) that shall be published via the mailing list. The patches will be discussed, merged & uploaded on the git. +Please do not forget to document your changes: +- write a manual for new components or adapt manuals to the changes you have made +- in case you have added a new program please write a man page for it +- if you have added something to the DLT API please remember to provide Doxygen comments + +Please add a header to the top of each new source file you provide: + +---- +/* + * @licence app begin@ + * SPDX license identifier: MPL-2.0 + * + * Copyright (C) 2011-2016, {COPYRIGHT_HOLDER} + * + * This file is part of GENIVI Project DLT - Diagnostic Log and Trace. + * + * This Source Code Form is subject to the terms of the + * Mozilla Public License (MPL), v. 2.0. + * If a copy of the MPL was not distributed with this file, + * You can obtain one at http://mozilla.org/MPL/2.0/. + * + * For further information see http://www.genivi.org/. + * @licence end@ + */ + +/*! + * \author {YOUR NAME <YOUR_EMAIL_ADDRESS>} + * + * \copyright Copyright © 2011-2016 {COPYRIGHT_HOLDER}. \n + * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. + * + * \file {FILENAME} +*/` +---- |