fix: group arguments in cli #1340
Conversation
|
fix #1337 |
Codecov Report
@@ Coverage Diff @@
## main #1340 +/- ##
==========================================
+ Coverage 79.31% 79.43% +0.11%
==========================================
Files 271 271
Lines 4908 4911 +3
Branches 593 593
==========================================
+ Hits 3893 3901 +8
+ Misses 866 861 -5
Partials 149 149
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
doc/MANUAL.md
Outdated
|
|
||
| ### -m INTERMEDIATE_REPORTS, --merge INTERMEDIATE_REPORTS | ||
|
|
||
| This option allows you to merge intermediate reports created using `-a` or `--append`. The output from the merged report produces a report on the console. But you can also use it along with `-f --format` and `-o --output-file` to produce output in other formats. It takes a list of comma-separated filepath. |
There was a problem hiding this comment.
| This option allows you to merge intermediate reports created using `-a` or `--append`. The output from the merged report produces a report on the console. But you can also use it along with `-f --format` and `-o --output-file` to produce output in other formats. It takes a list of comma-separated filepath. | |
| This option allows you to merge intermediate reports created using `-a` or `--append`. The output from the merged report produces a report on the console. But you can also use it along with `-f --format` and `-o --output-file` to produce output in other formats. It takes a list of comma-separated filepaths. |
cve_bin_tool/cli.py
Outdated
| @@ -73,18 +73,29 @@ def main(argv=None): | |||
| + "\n\nPlease disclose issues responsibly!", | |||
| formatter_class=argparse.RawDescriptionHelpFormatter, | |||
| ) | |||
|
|
|||
| nvd_database_group = parser.add_argument_group( | |||
| "NVD", "Arguments related to NVD Datbase and Cache Configuration" | |||
There was a problem hiding this comment.
| "NVD", "Arguments related to NVD Datbase and Cache Configuration" | |
| "CVE data download", "Arguments related to NVD Database and Cache Configuration" |
We've been kind of assuming that people know (or will look up) what the NVD is, but maybe we could use the heading to give them a hint here.
| @@ -660,6 +624,54 @@ indicates that CVEs may be present in the code. A good result here is 0. | |||
|
|
|||
| The logging modes provide additional fine-grained control for debug information. | |||
|
|
|||
| ## Merge Report Arguments | |||
|
|
|||
There was a problem hiding this comment.
| Users may wish to create and combine multiple cve-bin-tool reports to track how vulnerability changes over time, how long it takes to fix issues, or other changes between different reports. We have a number of options related to merging report data. | |
Taking a stab at an intro section with some common usages, mostly for users wondering if they should try out these arguments.
|
Merging #1273 caused a merge conflict. I believe I've resolved it correctly using the web interface but I'm going to let the tests run before assuming. |
|
Not entirely sure why it failed, in CI (it wasn't black!) so I'm going to try a re-run. |
No description provided.