Add the comment describing OR use case

[kconfig-hardened-check.git] / kconfig-hardened-check.py

diff --git a/kconfig-hardened-check.py b/kconfig-hardened-check.py
index d8f844705bcfa7d8290044d6b8225ffd9eb09af2..f66f61adc48749845f79dbfae7bce0468118be40 100755 (executable)
--- a/kconfig-hardened-check.py
+++ b/kconfig-hardened-check.py
@@ -59,6 +59,9 @@ class OR:
         self.opts = opts
         self.result = None
 
+    # self.opts[0] is the option which this OR-check is about.
+    # Use case: OR(<X_is_hardened>, <X_is_disabled>)
+
     @property
     def name(self):
         return self.opts[0].name