This is the mail archive of the elfutils-devel@sourceware.org mailing list for the elfutils project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[PATCH] doc: Fix DEBUGINFOD_PROGRESS description to just mention output on stderr.


An earlier variant of the default progress function could write to any
file. Which is still in the documentation. But the actual implementation
just uses stderr. Fix the documentation to match.

Signed-off-by: Mark Wielaard <mark@klomp.org>
---
 doc/ChangeLog                   | 5 +++++
 doc/debuginfod_find_debuginfo.3 | 4 ++--
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/doc/ChangeLog b/doc/ChangeLog
index b40a141b..c7e451d7 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2020-01-10  Mark Wielaard  <mark@klomp.org>
+
+	* debuginfod_find_debuginfo.3 (DEBUGINFOD_PROGRESS): Mention progress
+	output goes to stderr.
+
 2020-01-02  Mark Wielaard  <mark@klomp.org>
 
 	* debuginfod.8 (DEBUGINFOD_TIMEOUT): Document as seconds to
diff --git a/doc/debuginfod_find_debuginfo.3 b/doc/debuginfod_find_debuginfo.3
index f6ea7a45..7e5060f2 100644
--- a/doc/debuginfod_find_debuginfo.3
+++ b/doc/debuginfod_find_debuginfo.3
@@ -173,8 +173,8 @@ or negative means "no timeout".)
 This environment variable governs the default progress function.  If
 set, and if a progressfn is not explicitly set, then the library will
 configure a default progressfn.  This function will append a simple
-progress message periodically to the given file.  Consider using
-"/dev/stderr" on platforms that support it.  The default is nothing.
+progress message periodically to stderr.  The default is no progress
+function output.
 
 .TP 21
 .B DEBUGINFOD_CACHE_PATH
-- 
2.18.1


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]