From 4e74a20cc3c8275f25163269564c8b7791b5c13c Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Fri, 13 Nov 2015 15:43:31 +0200
Subject: Document verbosity levels

---
 bpkg/common-options.cli | 19 ++++++++++++++++---
 bpkg/diagnostics        |  2 +-
 2 files changed, 17 insertions(+), 4 deletions(-)

(limited to 'bpkg')

diff --git a/bpkg/common-options.cli b/bpkg/common-options.cli
index 8088ccc..04c67e3 100644
--- a/bpkg/common-options.cli
+++ b/bpkg/common-options.cli
@@ -2,7 +2,6 @@
 // copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
 // license   : MIT; see accompanying LICENSE file
 
-include <vector>;
 include <bpkg/types>;
 
 namespace bpkg
@@ -25,8 +24,22 @@ namespace bpkg
     {
       "<level>",
       "Set the diagnostics verbosity to <level> between 0 (disabled) and
-       6 (lots of information). The default is 1. @@ Need to document
-       further."
+       6 (lots of information). The default is 1. The following additional
+       classes of diagnostics are produced at each level:
+
+       \ol|
+
+       \li|high-level information messages|
+
+       \li|essential underlying commands that are being executed|
+
+       \li|all underlying commands that are being executed|
+
+       \li|information that could be helpful to the user|
+
+       \li|information that could be helpful to the developer|
+
+       \li|even more detailed information||"
     };
 
     path --fetch
diff --git a/bpkg/diagnostics b/bpkg/diagnostics
index 68aac63..3f95ffe 100644
--- a/bpkg/diagnostics
+++ b/bpkg/diagnostics
@@ -54,7 +54,7 @@ namespace bpkg
     print_process (args.data (), args.size ());
   }
 
-  // Verbosity level.
+  // Verbosity level. Update documentation for --verbose if changing.
   //
   // 0 - disabled
   // 1 - high-level information messages
-- 
cgit v1.1