diff options
| author | Jay Satiro <raysatiro@yahoo.com> | 2021-07-23 02:56:52 -0400 |
|---|---|---|
| committer | Jay Satiro <raysatiro@yahoo.com> | 2021-07-23 02:56:52 -0400 |
| commit | 9a6f974881b64acb802cf727ea3b473eb53196a0 (patch) | |
| tree | 329dd598ba8db4ba65c54eb31f24f679329ad483 | |
| parent | 673753344c5f6c66830ce37884a2b628da44a695 (diff) | |
| download | curl-9a6f974881b64acb802cf727ea3b473eb53196a0.tar.gz | |
docs: change max-filesize caveat again
- Add protocols field to max-filesize.d.
- Revert wording on unknown file size caveat and do not discuss specific
protocols in that section.
Partial revert of ecf0225. All max-filesize options now have the list of
protocols and it's clearer just to have that list without discussing
specific protocols in the caveat.
Reported-by: Josh Soref
Ref: https://github.com/curl/curl/issues/7453#issuecomment-884128762
| -rw-r--r-- | docs/cmdline-opts/max-filesize.d | 7 | ||||
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 | 6 | ||||
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 | 6 |
3 files changed, 10 insertions, 9 deletions
diff --git a/docs/cmdline-opts/max-filesize.d b/docs/cmdline-opts/max-filesize.d index 2f82998d7..6717f2d95 100644 --- a/docs/cmdline-opts/max-filesize.d +++ b/docs/cmdline-opts/max-filesize.d @@ -1,6 +1,7 @@ Long: max-filesize Arg: <bytes> Help: Maximum file size to download +Protocols: FTP HTTP MQTT See-also: limit-rate Category: connection --- @@ -12,6 +13,6 @@ A size modifier may be used. For example, Appending 'k' or 'K' will count the number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it gigabytes. Examples: 200K, 3m and 1G. (Added in 7.58.0) -**NOTE**: For protocols where the size is not known in advance (including FTP -and HTTP) this option has no effect even if the file transfer ends up being -larger than the given limit. +**NOTE**: The file size is not always known prior to download, and for such +files this option has no effect even if the file transfer ends up being larger +than this given limit.
\ No newline at end of file diff --git a/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 b/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 index 0f368fea8..32c10cddb 100644 --- a/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 +++ b/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 @@ -33,9 +33,9 @@ Pass a long as parameter. This allows you to specify the maximum \fIsize\fP this value, the transfer will not start and \fICURLE_FILESIZE_EXCEEDED\fP will be returned. -For protocols where the size is not known in advance (including FTP and HTTP) -this option has no effect even if the file transfer ends up being larger than -the given limit. +The file size is not always known prior to download, and for such files this +option has no effect even if the file transfer ends up being larger than this +given limit. If you want a limit above 2GB, use \fICURLOPT_MAXFILESIZE_LARGE(3)\fP. .SH DEFAULT diff --git a/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 index fa492e284..454a6029a 100644 --- a/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 +++ b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 @@ -35,9 +35,9 @@ Pass a curl_off_t as parameter. This allows you to specify the maximum larger than this value, the transfer will not start and \fICURLE_FILESIZE_EXCEEDED\fP will be returned. -For protocols where the size is not known in advance (including FTP and HTTP) -this option has no effect even if the file transfer ends up being larger than -the given limit. +The file size is not always known prior to download, and for such files this +option has no effect even if the file transfer ends up being larger than this +given limit. .SH DEFAULT None .SH PROTOCOLS |