]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: change max-filesize caveat again
authorJay Satiro <raysatiro@yahoo.com>
Fri, 23 Jul 2021 06:56:52 +0000 (02:56 -0400)
committerJay Satiro <raysatiro@yahoo.com>
Fri, 23 Jul 2021 06:56:52 +0000 (02:56 -0400)
- 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

docs/cmdline-opts/max-filesize.d
docs/libcurl/opts/CURLOPT_MAXFILESIZE.3
docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3

index 2f82998d7c1b3ac4196b44a03b00b1f81d7bcd80..6717f2d95458585ae2f04f4a28657992db1ce8eb 100644 (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.
\ No newline at end of file
index 0f368fea8cc9ead219cbfd317ba62c4a6830f252..32c10cddbfdb4c02c5217052a0a79beade940f33 100644 (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
index fa492e284ba1f8a4ededd67889af2c2054b999bc..454a6029ad774d67450878f8f675dba4ce9b7893 100644 (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