[PATCH] docs: correct symbols-in-versions & doc mismatch for 7.16.4

From: Ævar Arnfjörð Bjarmason via curl-library <curl-library_at_cool.haxx.se>
Date: Fri, 30 Jul 2021 19:09:19 +0200

These options introduced in 7.17.0 were documented in
9f44a9552 (Renamed several libcurl error codes[...], 2007-08-30) as
being introduced in version 7.16.4, but as looking at the 7.16.4 tag
and tarball[1] reveals they weren't added until 7.17.0.

The symbols file added later in c65f9acdc (introducing the
symbols-in-versions file[...], 2009-02-10) correctly lists them as
first appearing in 7.17.0, but this documentation was never updated
accordingly.
n
It might be useful to write a checking script to scrape the
symbols-in-versions file, and see if symbols declared there have
adjacent in-tree versions in the documentation that don't match that
file (i.e. to manually eyeball them). I have not written such a
script, let's just fix this particular discrepancy.

1. https://curl.se/download/archeology/curl-7.16.4.tar.gz

---
While working on deprecating support for older curl versions in the
git codebase (at [2]) I found that the documentation for when
CURLOPT_USE_SSL started being supported was incorrect.
This is my first contribution to curl, and I've just skimmed
https://curl.se/dev/contribute.html; I didn't run the build & tests
with this, but hopefully this is trivial enough to not trip up
anything in that area...
2. https://lore.kernel.org/git/cover-v3-0.7-00000000000-20210730T092843Z-avarab_at_gmail.com/
 docs/libcurl/opts/CURLOPT_APPEND.3      | 2 +-
 docs/libcurl/opts/CURLOPT_DIRLISTONLY.3 | 2 +-
 docs/libcurl/opts/CURLOPT_KEYPASSWD.3   | 2 +-
 docs/libcurl/opts/CURLOPT_USE_SSL.3     | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/libcurl/opts/CURLOPT_APPEND.3 b/docs/libcurl/opts/CURLOPT_APPEND.3
index 94d8da048..ba78f79de 100644
--- a/docs/libcurl/opts/CURLOPT_APPEND.3
+++ b/docs/libcurl/opts/CURLOPT_APPEND.3
_at__at_ -47,7 +47,7 _at__at_ if(curl) {
 }
 .fi
 .SH AVAILABILITY
-This option was known as CURLOPT_FTPAPPEND up to 7.16.4
+This option was known as CURLOPT_FTPAPPEND up to 7.17.0
 .SH RETURN VALUE
 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
 .SH "SEE ALSO"
diff --git a/docs/libcurl/opts/CURLOPT_DIRLISTONLY.3 b/docs/libcurl/opts/CURLOPT_DIRLISTONLY.3
index a2015c8b9..2ca435c6c 100644
--- a/docs/libcurl/opts/CURLOPT_DIRLISTONLY.3
+++ b/docs/libcurl/opts/CURLOPT_DIRLISTONLY.3
_at__at_ -65,7 +65,7 _at__at_ if(curl) {
 }
 .fi
 .SH AVAILABILITY
-This option was known as CURLOPT_FTPLISTONLY up to 7.16.4. POP3 is supported
+This option was known as CURLOPT_FTPLISTONLY up to 7.17.0. POP3 is supported
 since 7.21.5.
 .SH RETURN VALUE
 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
diff --git a/docs/libcurl/opts/CURLOPT_KEYPASSWD.3 b/docs/libcurl/opts/CURLOPT_KEYPASSWD.3
index 36f0eb61b..49d2b3200 100644
--- a/docs/libcurl/opts/CURLOPT_KEYPASSWD.3
+++ b/docs/libcurl/opts/CURLOPT_KEYPASSWD.3
_at__at_ -52,7 +52,7 _at__at_ if(curl) {
 }
 .fi
 .SH AVAILABILITY
-This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
+This option was known as CURLOPT_SSLKEYPASSWD up to 7.17.0 and
 CURLOPT_SSLCERTPASSWD up to 7.9.2.
 .SH RETURN VALUE
 Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
diff --git a/docs/libcurl/opts/CURLOPT_USE_SSL.3 b/docs/libcurl/opts/CURLOPT_USE_SSL.3
index 90cc88ad1..f1478b5cd 100644
--- a/docs/libcurl/opts/CURLOPT_USE_SSL.3
+++ b/docs/libcurl/opts/CURLOPT_USE_SSL.3
_at__at_ -61,7 +61,7 _at__at_ if(curl) {
 }
 .fi
 .SH AVAILABILITY
-Added in 7.11.0. This option was known as CURLOPT_FTP_SSL up to 7.16.4, and
+Added in 7.11.0. This option was known as CURLOPT_FTP_SSL up to 7.17.0, and
 the constants were known as CURLFTPSSL_*
 .SH RETURN VALUE
 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
-- 
2.32.0.1071.g36f34456314
-------------------------------------------------------------------
Unsubscribe: https://cool.haxx.se/list/listinfo/curl-library
Etiquette:   https://curl.se/mail/etiquette.html

Received on 2021-07-30