diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/debuginfod_find_debuginfo.3 | 10 |
2 files changed, 14 insertions, 1 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 068a1957..f598b7f2 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2020-03-29 Mark Wielaard <mark@klomp.org> + + * debuginfod_find_debuginfo.3 (HTTP HEADER): Document the expected + header format and purpose. + 2020-03-28 Frank Ch. Eigler <fche@redhat.com> * debuginfod.8: Document valid --port=NUM range, excludes 0. diff --git a/doc/debuginfod_find_debuginfo.3 b/doc/debuginfod_find_debuginfo.3 index 1c7c4991..d9717d73 100644 --- a/doc/debuginfod_find_debuginfo.3 +++ b/doc/debuginfod_find_debuginfo.3 @@ -171,7 +171,15 @@ may be called with strings of the form .BR \%"Header:\~value" . These strings are copied by the library. A zero return value indicates success, but out-of-memory conditions may result in -a non-zero \fI-ENOMEM\fP. +a non-zero \fI-ENOMEM\fP. If the string is in the wrong form +\fI-EINVAL\fP will be returned. + +Note that the current debuginfod-client library implementation uses +libcurl, but you shouldn't rely on that fact. Don't use this function +for replacing any standard headers, except for the User-Agent mentioned +below. The only supported usage of this function is for adding an +optional header which might or might not be passed through to the +server for logging purposes only. By default, the library adds a descriptive \fIUser-Agent:\fP header to outgoing requests. If the client application adds |