Closed
Description
- A bit of additional documentation in MANUAL.md and the cli options so we explicitly say that
--epss-*
need to be used with--metrics
or they won't have an effect
Originally posted by @terriko in #3618 (review)
I'm going to merge #3618 which will disable epss metrics by default (for performance reasons) but I think we should be explicit that the --metrics
will be needed before any of the epss options take effect.
For beginners, some steps to get started:
- Try doing a
grep -ri epss doc/
to see where epss is mentioned in our docs and make sure that it's clear that--metrics
will need to be used for the EPSS data to get used. (grep -ri
means search recursively and case-insensitively. So it'll search all of thedoc/
files.) - Do this search for epss again on the README.md file (which isn't in the
doc/
folder). - Take a look at the help text on the cli options in
cve_bin_tool/cli.py
and update the epss related ones. Remember to be concise since these help options have to fit on a screen and many people keep to an 80-character width in console views.