From: Mark Wielaard <mark@klomp.org>
Date: Fri, 10 Jan 2020 14:46:29 +0000 (+0100)
Subject: doc: Fix DEBUGINFOD_PROGRESS description to just mention output on stderr.
X-Git-Tag: elfutils-0.179~56
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2319680b334819767b7aeaf4e0f3de308e3c6e9c;p=platform%2Fupstream%2Felfutils.git

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>
---

diff --git a/doc/ChangeLog b/doc/ChangeLog
index 51088df..651ea33 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-11  Frank Ch. Eigler  <fche@redhat.com
 
 	* debuginfod.8: Document --fdcache-fds and --fdcache-mbs opts.
diff --git a/doc/debuginfod_find_debuginfo.3 b/doc/debuginfod_find_debuginfo.3
index f6ea7a4..7e5060f 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