Improve the 'pylint disable' statements
[kconfig-hardened-check.git] / kconfig_hardened_check / checks.py
index 5b917bfbfd41d5cc0f8dc781df6f512c0de51ea6..65d8acfe59afc5b6cab198811df3f221f446e757 100644 (file)
@@ -1,5 +1,15 @@
 #!/usr/bin/python3
 
+"""
+This tool helps me to check Linux kernel options against
+my security hardening preferences for X86_64, ARM64, X86_32, and ARM.
+Let the computers do their job!
+
+Author: Alexander Popov <alex.popov@linux.com>
+
+This module contains knowledge for checks.
+"""
+
 # N.B. Hardening sysctls:
 #    kernel.kptr_restrict=2 (or 1?)
 #    kernel.dmesg_restrict=1 (also see the kconfig option)
@@ -33,8 +43,8 @@
 #    amd_iommu=on
 #    efi=disable_early_pci_dma
 
-# pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
-# pylint: disable=line-too-long,invalid-name,too-many-branches,too-many-statements
+# pylint: disable=missing-function-docstring,line-too-long,invalid-name
+# pylint: disable=too-many-branches,too-many-statements,too-many-return-statements
 
 from .engine import KconfigCheck, CmdlineCheck, VersionCheck, OR, AND