luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: change max-filesize caveat again

Browse Source 
- 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
This commit is contained in:
Jay Satiro 2021-07-23 02:56:52 -04:00
parent 673753344c
commit 9a6f974881
3 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/cmdline-opts/max-filesize.d
View File

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

6
docs/libcurl/opts/CURLOPT_MAXFILESIZE.3
View File

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

6
docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3
View File

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