From a318eae1ee29412a0ee5a8170a58fdbf04bd3a41 Mon Sep 17 00:00:00 2001
From: Fabrice Fontaine <fabrice.fontaine@orange.com>
Date: Thu, 6 Oct 2022 10:06:16 +0200
Subject: [PATCH] fix: update detailed description

detailed option was added by commit
4f3538e89d5510d5bfc1c2c288dd96f491485884 with the following description:
"display detailed report" which is a bit cryptic so replace it by "add
CVE description in csv or json report (no effect on console, html or
pdf)".

Signed-off-by: Fabrice Fontaine <fabrice.fontaine@orange.com>
---
 README.md           | 2 +-
 cve_bin_tool/cli.py | 5 ++++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 53c9f399c2..aa5a7e2c09 100644
--- a/README.md
+++ b/README.md
@@ -411,7 +411,7 @@ options:
   <a href="https://github.com/intel/cve-bin-tool/blob/main/doc/MANUAL.md#--disable-validation-check">--disable-validation-check</a>
                         skips checking xml files against schema
   --offline             operate in offline mode
-  --detailed            display detailed report
+  --detailed            add CVE description in csv or json report (no effect on console, html or pdf)
 
 CVE Data Download:
   Arguments related to data sources and Cache Configuration
diff --git a/cve_bin_tool/cli.py b/cve_bin_tool/cli.py
index b1a619d28f..b9ec81a297 100644
--- a/cve_bin_tool/cli.py
+++ b/cve_bin_tool/cli.py
@@ -375,7 +375,10 @@ def main(argv=None):
         default=False,
     )
     parser.add_argument(
-        "--detailed", action="store_true", help="display detailed report", default=False
+        "--detailed",
+        action="store_true",
+        help="add CVE description in csv or json report (no effect on console, html or pdf)",
+        default=False,
     )
 
     merge_report_group = parser.add_argument_group(