Inform about supporting *.gz kconfig files
authorAlexander Popov <alex.popov@linux.com>
Sun, 26 Mar 2023 15:19:55 +0000 (18:19 +0300)
committerAlexander Popov <alex.popov@linux.com>
Sun, 26 Mar 2023 15:31:19 +0000 (18:31 +0300)
Refers to #80

README.md
kconfig_hardened_check/__init__.py

index a6e3b089e5388808f110fd51779f8028dc909595..0fd80e94899c614e740cc947201818b26871954f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -63,20 +63,19 @@ Some Linux distributions also provide `kconfig-hardened-check` as a package.
 
 ## Usage
 ```
-usage: kconfig-hardened-check [-h] [--version] [-p {X86_64,X86_32,ARM64,ARM}]
-                              [-c CONFIG]
-                              [-l CMDLINE]
-                              [-m {verbose,json,show_ok,show_fail}]
+usage: kconfig-hardened-check [-h] [--version] [-p {X86_64,X86_32,ARM64,ARM}] [-c CONFIG]
+                              [-l CMDLINE] [-m {verbose,json,show_ok,show_fail}]
 
 A tool for checking the security hardening options of the Linux kernel
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   --version             show program's version number and exit
   -p {X86_64,X86_32,ARM64,ARM}, --print {X86_64,X86_32,ARM64,ARM}
                         print security hardening preferences for the selected architecture
   -c CONFIG, --config CONFIG
-                        check the kernel kconfig file against these preferences
+                        check the kernel kconfig file against these preferences (also supports
+                        *.gz files)
   -l CMDLINE, --cmdline CMDLINE
                         check the kernel cmdline file against these preferences
   -m {verbose,json,show_ok,show_fail}, --mode {verbose,json,show_ok,show_fail}
index c6c4349839f4ed4448a5f10e217d7135aedc9003..4aa03473fe4b4e21eb26de9f03f615038bcbe3d2 100644 (file)
@@ -213,7 +213,7 @@ def main():
     parser.add_argument('-p', '--print', choices=supported_archs,
                         help='print security hardening preferences for the selected architecture')
     parser.add_argument('-c', '--config',
-                        help='check the kernel kconfig file against these preferences')
+                        help='check the kernel kconfig file against these preferences (also supports *.gz files)')
     parser.add_argument('-l', '--cmdline',
                         help='check the kernel cmdline file against these preferences')
     parser.add_argument('-m', '--mode', choices=report_modes,