From d492d06e0a981010bce5b9114abcd3717279dd02 Mon Sep 17 00:00:00 2001 From: Steve Bedford Date: Mon, 11 Feb 2019 14:31:32 -0500 Subject: [PATCH] Update README for kernel config filter section and maintainers --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b84fdd3..6635afe 100644 --- a/README.md +++ b/README.md @@ -44,15 +44,24 @@ When you run the following script without any arguments, you will be prompted to ### Create an image manifest (optional) -The _checkcves.py_ script will create a manifest automatically, but you may want to save certain configurations to pass to the script, upload to LinuxLink, or share with teammates or Timesys support. +The _checkcves.py_ script will create a manifest automatically, but you may want to save certain configurations to pass to the script, upload to LinuxLink, or share with teammates or Timesys support. Using a pregenerated image manifest speeds up the script significantly, so doing that is recommended if your configuration is not changing often. ```sh ../meta-timesys/scripts/manifest.sh core-image-minimal manifest.json ``` +### Kernel Config filter (optional) + +You may pass a kernel _.config_ file to the _checkcves.py_ script, which will be uploaded to LinuxLink along with the image manifest. This filter will reduce the number of kernel CVEs reported by removing those related to features which are not being built for your kernel. + +**NOTE: This must be a _full_ kernel config, not a defconfig!** + +```sh +../meta-timesys/scripts/checkcves.py -k /path/to/kernel/.config +``` + + Maintainers =========== Steve Bedford \ - -Ian Campbell \