From 7cbea6d908fddc48357a88d6edf30451c7d2b487 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Thu, 21 Oct 2021 17:17:09 +0200
Subject: Add --progress common option

---
 bpkg/common.cli | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

(limited to 'bpkg/common.cli')

diff --git a/bpkg/common.cli b/bpkg/common.cli
index 46c4784..5f67357 100644
--- a/bpkg/common.cli
+++ b/bpkg/common.cli
@@ -103,15 +103,23 @@ namespace bpkg
 
     // When it comes to external programs (such as curl, git, etc), if stderr
     // is not a terminal, the logic is actually tri-state: With --no-progress
-    // we suppress any progress. With --progress (which we may add in the
-    // future), we request full progress. Finally, without any --*progress
-    // options we let the external program decide what to do: it may do
-    // something intelligent (like curl) and produce non-terminal-friendly
-    // progress (such as status lines printed periodically) or it may disable
-    // progress all together (like git). Of course, it may also do no
-    // detection and dump non-terminal-unfriendly progress in which case we
-    // should probably do the detection ourselves and suppress it.
+    // we suppress any progress. With --progress we request full progress.
+    // Finally, without any --*progress options we let the external program
+    // decide what to do: it may do something intelligent (like curl) and
+    // produce non-terminal-friendly progress (such as status lines printed
+    // periodically) or it may disable progress all together (like git). Of
+    // course, it may also do no detection and dump non-terminal-unfriendly
+    // progress in which case we should probably do the detection ourselves
+    // and suppress it.
     //
+    bool --progress
+    {
+      "Display progress indicators for long-lasting operations, such as
+       network transfers, building, etc. If printing to a terminal the
+       progress is displayed by default for low verbosity levels. Use
+       \cb{--no-progress} to suppress."
+    }
+
     bool --no-progress
     {
       "Suppress progress indicators for long-lasting operations, such as
-- 
cgit v1.1