doc FEATURE building process description
High level information providing information about different build
types, their purpose and available cmake options a make targets.
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 88d05a8..89702d1 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -175,11 +175,12 @@
if(("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG") OR ("${BUILD_TYPE_UPPER}" STREQUAL "RELWITHDEBINFO"))
option(ENABLE_BUILD_TESTS "Build tests" ON)
option(ENABLE_VALGRIND_TESTS "Build tests with valgrind" ON)
- set(INTERNAL_DOCS NO) # TODO enable when the internal docs ready
+ # TODO enable when the internal docs ready
+ set(INTERNAL_DOCS "Include developers notes and internal API description into generated Documentation" OFF)
else()
option(ENABLE_BUILD_TESTS "Build tests" OFF)
option(ENABLE_VALGRIND_TESTS "Build tests with valgrind" OFF)
- set(INTERNAL_DOCS NO)
+ set(INTERNAL_DOCS "Include developers notes and internal API description into generated Documentation" OFF)
endif()
option(ENABLE_COVERAGE "Build code coverage report from tests" OFF)
option(ENABLE_FUZZ_TARGETS "Build target programs suitable for fuzzing with AFL" OFF)
@@ -308,7 +309,9 @@
endif()
# source code format
-source_format(src/* compat/*)
+if ("${BUILD_TYPE_UPPER}" STREQUAL "DEBUG")
+ source_format(src/* compat/*)
+endif()
# clean cmake cache
add_custom_target(cclean
diff --git a/Doxyfile.in b/Doxyfile.in
index 9abc3c9..848c353 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -781,7 +781,7 @@
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = doc/transition.dox @DOXY_HEADERS@
+INPUT = doc/build.dox doc/transition.dox @DOXY_HEADERS@
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
diff --git a/doc/build.dox b/doc/build.dox
new file mode 100644
index 0000000..77fd165
--- /dev/null
+++ b/doc/build.dox
@@ -0,0 +1,139 @@
+/**
+ * @page build Building libyang
+ *
+ * [TOC]
+ *
+ * libyang utilizes CMake build system to detect necessary dependencies, checkout the build environment and prepare Makefiles
+ * for the compilation of the library and acompanied tools.
+ *
+ * @section buildRequirements Requirements
+ *
+ * @subsection buildRequirementsCompile Building Requirements
+ *
+ * - C compiler (gcc, clang, ...)
+ * - CMake >= 2.8.12
+ * - libpcre2 (including headers - devel package) >= 10.30
+ *
+ * @subsubsection buildRequirementsCompileOptional Optional Requirements
+ *
+ * - doxygen (for generating documentation)
+ * - cmocka >= 1.0.0 (for tests)
+ * - valgrind (for enhanced testing)
+ * - gcov (for code coverage)
+ * - lcov (for code coverage)
+ * - genhtml (for code coverage)
+ *
+ * @subsection buildRequirementsRun Runtime Requirements
+ *
+ * - libpcre2 (runtime package) >= 10.30
+ *
+ * @section buildCommands Building
+ *
+ * To simply build libyang library and the accompanied tools with the default settings, follow these steps (the `#` character
+ * indicates command(s) to run with `root` privileges):
+ *
+ * $ mkdir build; cd build
+ * $ cmake ..
+ * $ make
+ * # make install
+ *
+ * The default settings can be changed with various CMake variables set via command line or using e.g. `ccmake(1)` tool.
+ * The following sections introduces those variables and explain their meaning.
+ *
+ * @section buildTypes Build Types
+ *
+ * There are several build types according to the primary goal of using the built binaries.
+ *
+ * @subsection buildTypesRelese Release
+ *
+ * Build type to produce final binaries for production use without any debug option. The compiler flags are set as follows:
+ *
+ * -Wall -Wextra -Wno-missing-field-initializers -std=c99 -O3 -DNDEBUG
+ *
+ * Here is the list of the selected additional options available in the *Release* build type.
+ *
+ * Option | Description | Default
+ * ----------------------|------------------------------------------------------------------------------------|--------
+ * ENABLE_BUILD_TESTS | Build tests. | OFF
+ * ENABLE_VALGRIND_TESTS | Build tests with valgrind. | OFF
+ * ENABLE_COVERAGE | Build code coverage report from tests. | OFF
+ * ENABLE_FUZZ_TARGETS | Build target programs suitable for fuzzing with AFL. | OFF
+ * ENABLE_STATIC | Build static (.a) library | OFF
+ * INTERNAL_DOCS | Include developers notes and internal API description into generated Documentation | OFF
+ *
+ * Here is the list of available important targets for the `make(1)` tool:
+ *
+ * Target | Description
+ * -------|------------------------------------------------------------------------------------------------------------
+ * all | Default target, builds libyang library (.so), `yanglint(1)` and `yangre(1)`.
+ * clean | Removes files generated by the make process.
+ * cclean | Extends the `clean` target by removing all the cmake generated files.
+ * doc | Generate HTML documentation. Requires `doxygen(1)`.
+ *
+ * @subsection buildTypesDebug Debug
+ *
+ * `Debug` is the default build type, the produced binaries include additional debug information and the prepared tests are
+ * also built. The compiler flags are set as follows:
+ *
+ * -Wall -Wextra -Wno-missing-field-initializers -std=c99 -g3 -O0
+ *
+ * Here is the list of the selected additional options available in the *Debug* build type.
+ *
+ * Option | Description | Default
+ * ----------------------|------------------------------------------------------------------------------------|--------
+ * ENABLE_BUILD_TESTS | Build tests. | ON
+ * ENABLE_VALGRIND_TESTS | Build tests with valgrind. | ON
+ * ENABLE_COVERAGE | Build code coverage report from tests. | OFF
+ * ENABLE_FUZZ_TARGETS | Build target programs suitable for fuzzing with AFL. | OFF
+ * ENABLE_STATIC | Build static (.a) library | OFF
+ * INTERNAL_DOCS | Include developers notes and internal API description into generated Documentation | OFF
+ *
+ * Here is the list of available important targets for the `make(1)` tool:
+ *
+ * Target | Description
+ * -------------|------------------------------------------------------------------------------------------------------
+ * all | Default target, builds libyang library (.so), `yanglint(1)` and `yangre(1)`.
+ * clean | Removes files generated by the make process.
+ * cclean | Extends the `clean` target by removing all the cmake generated files.
+ * doc | Generate HTML documentation. Requires `doxygen(1)`.
+ * test | Run implementation tests. Requires `cmocka` (and `valgrind(1)` for part of the tests).
+ * format | Reformat source codes using `uncrustify(1)`.
+ * format-check | Dry-run of the `format` target.
+ *
+ * @subsection buildTypesABICheck ABICheck
+ *
+ * Special build type to perform check of the ABI/API compatibility and generate reports. In addition to the basic
+ * requirements, the build type requires some of the <a href="https://abi-laboratory.pro/">ABI Laboratory tools</a>:
+ * `abi-dumper(1)` and `abi-compliance-checker(1)`.
+ *
+ * The compiler flags are set as follows:
+ *
+ * -Wall -Wextra -Wno-missing-field-initializers -std=c99 -g -Og
+ *
+ * All the additional options are switched OFF and the settings should not be changed.
+ *
+ * Here is the list of available important targets for the `make(1)` tool:
+ *
+ * Target | Description
+ * -------------|------------------------------------------------------------------------------------------------------
+ * all | Default target, builds libyang library (.so), `yanglint(1)` and `yangre(1)`.
+ * clean | Removes files generated by the make process.
+ * cclean | Extends the `clean` target by removing all the cmake generated files.
+ * doc | Generate HTML documentation. Requires `doxygen(1)`.
+ * abi-check | Check the backward compatibility of the API/ABI changes. Requires `abi-compliance-checker(1)` and `abi-dump(1)`.
+ * abi-dump | Helper target for `abi-check` generating API/ABI reports. Requires `abi-dump(1)`.
+
+ * @subsection buildTypesDocOnly DocOnly
+ *
+ * Special build type to avoid any requirements except those for building documentation. There are no compiler flags set
+ * since the build type does not allow building any binary output. The settings of the additional options should not be
+ * changed.
+ *
+ * Here is the list of available important targets for the `make(1)` tool:
+ *
+ * Target | Description
+ * -------------|------------------------------------------------------------------------------------------------------
+ * all | Default target, does nothing.
+ * doc | Generate HTML documentation. Requires `doxygen(1)`.
+ *
+ */
diff --git a/src/log.h b/src/log.h
index 1766fbe..7fca790 100644
--- a/src/log.h
+++ b/src/log.h
@@ -56,7 +56,7 @@
*
* As a separate group, there are @ref dbggroup to select group of debugging messages to print. The options can be set via
* ::ly_log_dbg_groups() function, but note that the options take effect only in case the libyang is compiled in
- * [Debug build mode](@ref building).
+ * [Debug build mode](@ref build).
*
* \note API for this group of functions is described in the [logger module](@ref log).
*