summaryrefslogtreecommitdiff
path: root/doc/debuginfod.8
diff options
context:
space:
mode:
authorNoah Sanci <nsanci@redhat.com>2021-08-10 11:21:35 -0400
committerNoah Sanci <nsanci@redhat.com>2021-09-16 10:21:15 -0400
commitff5056c7d78b925fbd49997dc88183f6c859ac7f (patch)
tree9ab1ff609f41406578a6901a841678f193e94db0 /doc/debuginfod.8
parent00f0fa77c995684060aa8ea6fe7276ed9b593d11 (diff)
downloadelfutils-ff5056c7d78b925fbd49997dc88183f6c859ac7f.tar.gz
debuginfod: PR27277 - Describe retrieved files when verbose
Allow users, with enough verbosity, to print the HTTP response headers upon retrieving a file. These files may include several custome http response headers such as X-DEBUGINFOD-FILE, X-DEBUGINFOD-SIZE, and X-DEBUGINFOD-ARCHIVE. These headers are added from the daemon, in debuginfod.cxx. E.g output: HTTP/1.1 200 OK Connection: Keep-Alive Content-Length: 4095072 Cache-Control: public Last-Modified: Thu, 09 Sep 2021 19:06:40 GMT X-FILE: debuginfod X-FILE-SIZE: 4095072 Content-Type: application/octet-stream Date: Fri, 10 Sep 2021 16:38:06 GMT https://sourceware.org/bugzilla/show_bug.cgi?id=27277 Signed-off-by: Noah Sanci <nsanci@redhat.com>
Diffstat (limited to 'doc/debuginfod.8')
-rw-r--r--doc/debuginfod.89
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/debuginfod.8 b/doc/debuginfod.8
index f9a418d1..fde06bb8 100644
--- a/doc/debuginfod.8
+++ b/doc/debuginfod.8
@@ -258,6 +258,15 @@ Unknown buildid / request combinations result in HTTP error codes.
This file service resemblance is intentional, so that an installation
can take advantage of standard HTTP management infrastructure.
+Upon finding a file in an archive or simply in the database, some
+custom http headers are added to the response. For files in the
+database X-DEBUGINFOD-FILE and X-DEBUGINFOD-SIZE are added.
+X-DEBUGINFOD-FILE is simply the unescaped filename and
+X-DEBUGINFOD-SIZE is the size of the file. For files found in archives,
+in addition to X-DEBUGINFOD-FILE and X-DEBUGINFOD-SIZE,
+X-DEBUGINFOD-ARCHIVE is added. X-DEBUGINFOD-ARCHIVE is the name of the
+archive the file was found in.
+
There are three requests. In each case, the buildid is encoded as a
lowercase hexadecimal string. For example, for a program \fI/bin/ls\fP,
look at the ELF note GNU_BUILD_ID: