aboutsummaryrefslogtreecommitdiff
path: root/libbutl/diagnostics.hxx
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2017-08-05 04:06:53 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2017-08-06 12:27:55 +0300
commit561a189f49441a4d211c0217dce8127f2ce7c32e (patch)
treec7928517d65fe7ee9deeaa677d91fd95650c6a9b /libbutl/diagnostics.hxx
parent07f657754b0af656ee48c38540805fcec7cee27d (diff)
Fix printing progress to non-terminal STDERR
Diffstat (limited to 'libbutl/diagnostics.hxx')
-rw-r--r--libbutl/diagnostics.hxx15
1 files changed, 8 insertions, 7 deletions
diff --git a/libbutl/diagnostics.hxx b/libbutl/diagnostics.hxx
index 9544945..c1491d6 100644
--- a/libbutl/diagnostics.hxx
+++ b/libbutl/diagnostics.hxx
@@ -52,13 +52,14 @@ namespace butl
// Progress line facility.
//
// The idea is to keep a progress line at the bottom of the terminal with
- // other output scrolling above it. The printing of the progress line is
- // integrated into diag_stream_lock and diag_progress_lock. To print or
- // update the progress acquire diag_progress_lock and update the
- // diag_progress string. To remove the progress line, set this string to
- // empty. For better readability start the progress line with a space
- // (which is where the cursor will be parked). Should only be used if
- // diag_stream points to std::cerr.
+ // other output scrolling above it. For a non-terminal STDERR the progress
+ // line is printed as a regular one terminated with the newline character.
+ // The printing of the progress line is integrated into diag_stream_lock and
+ // diag_progress_lock. To print or update the progress acquire
+ // diag_progress_lock and update the diag_progress string. To remove the
+ // progress line, set this string to empty. For better readability start the
+ // progress line with a space (which is where the cursor will be parked).
+ // Should only be used if diag_stream points to std::cerr.
//
// Note that child processes writing to the same stream may not completely
// overwrite the progress line so in this case it makes sense to keep the