CURLINFO_PRETRANSFER_TIME.3: clarify

... the timer *does* include the instructions for getting the remote
file.

Ref: #6452
Closes #6453
This commit is contained in:
Daniel Stenberg 2021-01-14 14:22:25 +01:00
parent e87ad71d1b
commit ec8dcd7b33
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2

View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___ .\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____| .\" * \___|\___/|_| \_\_____|
.\" * .\" *
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * .\" *
.\" * This software is licensed as described in the file COPYING, which .\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms .\" * you should have received as part of this distribution. The terms
@ -29,10 +29,11 @@ CURLINFO_PRETRANSFER_TIME \- get the time until the file transfer start
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME, double *timep); CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME, double *timep);
.SH DESCRIPTION .SH DESCRIPTION
Pass a pointer to a double to receive the time, in seconds, it took from the Pass a pointer to a double to receive the time, in seconds, it took from the
start until the file transfer is just about to begin. This includes all start until the file transfer is just about to begin.
pre-transfer commands and negotiations that are specific to the particular
protocol(s) involved. It does \fInot\fP involve the sending of the protocol- This time-stamp includes all pre-transfer commands and negotiations that are
specific request that triggers a transfer. specific to the particular protocol(s) involved. It includes the sending of
the protocol- specific protocol instructions that triggers a transfer.
When a redirect is followed, the time from each request is added together. When a redirect is followed, the time from each request is added together.