Skip to contentSkip to conversation

doc: add note into coding style

PATCH Applied Marko Kovacevic 3 participants 3 messages Sep 17, 2018 – Nov 24, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: add note into coding style

Added a note into the coding style to
highlight the use of a bool within a struct

---
 doc/guides/contributing/coding_style.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
doc/guides/contributing/coding_style.rst +9 -0
index b1bf0d1..8b1febe 100644
@@ -247,6 +247,15 @@ Structure Declarations
 * Use of the structures should be by separate variable declarations and those declarations must be extern if they are declared in a header file.
 * Externally visible structure definitions should have the structure name prefixed by ``rte_`` to avoid namespace collisions.
 
+.. note::
+
+    Uses of ``bool`` in structures are not preferred as is wastes space and
+    it's also not clear as to what type size the bool is. A preferred use of
+    ``bool`` is mainly as a return type from functions that return true/false,
+    and maybe local variable functions.
+
+    Ref: `LKML <https://lkml.org/lkml/2017/11/21/384>`_
+
 Queues
 ~~~~~~
 
Signature · 1 line
2.9.5