]> git.droids-corp.org - dpdk.git/blobdiff - doc/guides/contributing/coding_style.rst
timer: clarify error if subsystem already initialized
[dpdk.git] / doc / guides / contributing / coding_style.rst
index bb3f3efcbc556c231999d24adb3bf9e96fa36d9d..734d1901b22bb1e7fa6c16ec7374c3a6807e3035 100644 (file)
@@ -891,6 +891,18 @@ headers
        installed to $PREFIX/include when ``ninja install`` is run. As with
        source files, these should be specified using the meson ``files()``
        function.
+       When ``check_includes`` build option is set to ``true``, each header file
+       has additional checks performed on it, for example to ensure that it is
+       not missing any include statements for dependent headers.
+       For header files which are public, but only included indirectly in
+       applications, these checks can be skipped by using the ``indirect_headers``
+       variable rather than ``headers``.
+
+indirect_headers
+       **Default Value = []**.
+       As with ``headers`` option above, except that the files are not checked
+       for all needed include files as part of a DPDK build when
+       ``check_includes`` is set to ``true``.
 
 includes:
        **Default Value = []**.