docs: mention max-filesize options also apply to MQTT transfers

Also make it clearer that the caveat 'if the file size is unknown it
the option will have no effect' may apply to protocols other than FTP
and HTTP.

Reported-by: Josh Soref
Fixes https://github.com/curl/curl/issues/7453

diff --git a/docs/cmdline-opts/max-filesize.d b/docs/cmdline-opts/max-filesize.d
index e1e2849fcf4ad20053a8cbd04d8cadef7164bb13..2f82998d7c1b3ac4196b44a03b00b1f81d7bcd80 100644 (file)
--- a/docs/cmdline-opts/max-filesize.d
+++ b/docs/cmdline-opts/max-filesize.d
@@ -12,6 +12,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**: 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. This concerns both FTP and HTTP transfers.
+**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.

diff --git a/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 b/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3
index 172ae81c9aa17f99e31a4c6c04cf06e851791381..0f368fea8cc9ead219cbfd317ba62c4a6830f252 100644 (file)
--- a/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3
+++ b/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3
@@ -33,15 +33,15 @@ 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.
 
-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. This concerns both FTP and HTTP transfers.
+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.
 
 If you want a limit above 2GB, use \fICURLOPT_MAXFILESIZE_LARGE(3)\fP.
 .SH DEFAULT
 None
 .SH PROTOCOLS
-FTP and HTTP
+FTP, HTTP and MQTT
 .SH EXAMPLE
 .nf
 CURL *curl = curl_easy_init();

diff --git a/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3
index 3af97f83fe36e33e1e46696bfb3931b172cf5290..fa492e284ba1f8a4ededd67889af2c2054b999bc 100644 (file)
--- a/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3
+++ b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3
@@ -35,13 +35,13 @@ 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.
 
-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. This concerns both FTP and HTTP transfers.
+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.
 .SH DEFAULT
 None
 .SH PROTOCOLS
-FTP and HTTP
+FTP, HTTP and MQTT
 .SH EXAMPLE
 .nf
 CURL *curl = curl_easy_init();