cmake: tidy up option descriptions

- capitalize.
- impartive voice.
- stick to `Build ...`, `Use ...`, `Enable ...`, `Disable ...` with
  a couple of exceptions.
- drop period.
- fix wolfSSH, WebSockets casing.

Closes #14636

diff --git a/CMake/CurlSymbolHiding.cmake b/CMake/CurlSymbolHiding.cmake
index 3fcc4ba5433ff06caaabd0a2ab95f57305c38efe..00b7b3c106cb3342edefe039d0a0dc693db544f7 100644 (file)
--- a/CMake/CurlSymbolHiding.cmake
+++ b/CMake/CurlSymbolHiding.cmake
@@ -23,7 +23,7 @@
 ###########################################################################
 include(CheckCSourceCompiles)
 
-option(CURL_HIDDEN_SYMBOLS "Set to ON to hide libcurl internal symbols (=hide all symbols that are not officially external)." ON)
+option(CURL_HIDDEN_SYMBOLS "Hide libcurl internal symbols (=hide all symbols that are not officially external)" ON)
 mark_as_advanced(CURL_HIDDEN_SYMBOLS)
 
 if(WIN32 AND (ENABLE_DEBUG OR ENABLE_CURLDEBUG))

diff --git a/CMakeLists.txt b/CMakeLists.txt
index d6dbedb4de676167768794a8cfbb8c1ca6415862..0ab2660abd6ab85ebc82585064695c65114fccc7 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -118,17 +118,17 @@ endif()
 
 option(CURL_WERROR "Turn compiler warnings into errors" OFF)
 option(PICKY_COMPILER "Enable picky compiler options" ON)
-option(BUILD_CURL_EXE "Set to ON to build curl executable." ON)
+option(BUILD_CURL_EXE "Build curl executable" ON)
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)
 option(BUILD_STATIC_LIBS "Build static libraries" OFF)
 option(BUILD_STATIC_CURL "Build curl executable with static libcurl" OFF)
-option(ENABLE_ARES "Set to ON to enable c-ares support" OFF)
-option(CURL_DISABLE_INSTALL "Set to ON to disable installation targets" OFF)
+option(ENABLE_ARES "Enable c-ares support" OFF)
+option(CURL_DISABLE_INSTALL "Disable installation targets" OFF)
 
 if(WIN32)
-  option(CURL_STATIC_CRT "Set to ON to build libcurl with static CRT on Windows (/MT)." OFF)
+  option(CURL_STATIC_CRT "Build libcurl with static CRT on Windows (/MT)" OFF)
 
-  option(ENABLE_UNICODE "Set to ON to use the Unicode version of the Windows API functions" OFF)
+  option(ENABLE_UNICODE "Use the Unicode version of the Windows API functions" OFF)
   if(ENABLE_UNICODE)
     add_definitions("-DUNICODE" "-D_UNICODE")
     if(MINGW)
@@ -155,16 +155,16 @@ if(WIN32)
   # Avoid storing HAVE_WIN32_WINNT in CMake cache
   unset(HAVE_WIN32_WINNT CACHE)
 endif()
-option(CURL_LTO "Turn on compiler Link Time Optimizations" OFF)
+option(CURL_LTO "Enable compiler Link Time Optimizations" OFF)
 
-cmake_dependent_option(ENABLE_THREADED_RESOLVER "Set to ON to enable threaded DNS lookup"
+cmake_dependent_option(ENABLE_THREADED_RESOLVER "Enable threaded DNS lookup"
   ON "NOT ENABLE_ARES"
   OFF)
 
 include(PickyWarnings)
 
-option(ENABLE_DEBUG "Set to ON to enable curl debug features" OFF)
-option(ENABLE_CURLDEBUG "Set to ON to build with TrackMemory feature enabled" ${ENABLE_DEBUG})
+option(ENABLE_DEBUG "Enable curl debug features" OFF)
+option(ENABLE_CURLDEBUG "Enable TrackMemory feature" ${ENABLE_DEBUG})
 
 if(MSVC)
   set(ENABLE_CURLDEBUG OFF)  # FIXME: TrackMemory + MSVC fails test 558 and 1330. Tested with static build, Debug mode.
@@ -215,7 +215,7 @@ if(UNIX OR (MSVC AND VCPKG_TOOLCHAIN))  # Keep this in sync with CMake/curl-conf
 else()
   set(_curl_use_pkgconfig_default OFF)
 endif()
-option(CURL_USE_PKGCONFIG "use pkg-config to detect dependencies" ${_curl_use_pkgconfig_default})
+option(CURL_USE_PKGCONFIG "Enable pkg-config to detect dependencies" ${_curl_use_pkgconfig_default})
 
 # Initialize CURL_LIBS
 set(CURL_LIBS "")
@@ -231,96 +231,96 @@ endif()
 
 include(CurlSymbolHiding)
 
-option(CURL_ENABLE_EXPORT_TARGET "to enable cmake export target" ON)
+option(CURL_ENABLE_EXPORT_TARGET "Enable CMake export target" ON)
 mark_as_advanced(CURL_ENABLE_EXPORT_TARGET)
 
-option(CURL_DISABLE_ALTSVC "disables alt-svc support" OFF)
+option(CURL_DISABLE_ALTSVC "Disable alt-svc support" OFF)
 mark_as_advanced(CURL_DISABLE_ALTSVC)
-option(CURL_DISABLE_SRP "disables TLS-SRP support" OFF)
+option(CURL_DISABLE_SRP "Disable TLS-SRP support" OFF)
 mark_as_advanced(CURL_DISABLE_SRP)
-option(CURL_DISABLE_COOKIES "disables cookies support" OFF)
+option(CURL_DISABLE_COOKIES "Disable cookies support" OFF)
 mark_as_advanced(CURL_DISABLE_COOKIES)
-option(CURL_DISABLE_BASIC_AUTH "disables Basic authentication" OFF)
+option(CURL_DISABLE_BASIC_AUTH "Disable Basic authentication" OFF)
 mark_as_advanced(CURL_DISABLE_BASIC_AUTH)
-option(CURL_DISABLE_BEARER_AUTH "disables Bearer authentication" OFF)
+option(CURL_DISABLE_BEARER_AUTH "Disable Bearer authentication" OFF)
 mark_as_advanced(CURL_DISABLE_BEARER_AUTH)
-option(CURL_DISABLE_DIGEST_AUTH "disables Digest authentication" OFF)
+option(CURL_DISABLE_DIGEST_AUTH "Disable Digest authentication" OFF)
 mark_as_advanced(CURL_DISABLE_DIGEST_AUTH)
-option(CURL_DISABLE_KERBEROS_AUTH "disables Kerberos authentication" OFF)
+option(CURL_DISABLE_KERBEROS_AUTH "Disable Kerberos authentication" OFF)
 mark_as_advanced(CURL_DISABLE_KERBEROS_AUTH)
-option(CURL_DISABLE_NEGOTIATE_AUTH "disables negotiate authentication" OFF)
+option(CURL_DISABLE_NEGOTIATE_AUTH "Disable negotiate authentication" OFF)
 mark_as_advanced(CURL_DISABLE_NEGOTIATE_AUTH)
-option(CURL_DISABLE_AWS "disables AWS-SIG4" OFF)
+option(CURL_DISABLE_AWS "Disable AWS-SIG4" OFF)
 mark_as_advanced(CURL_DISABLE_AWS)
-option(CURL_DISABLE_DICT "disables DICT" OFF)
+option(CURL_DISABLE_DICT "Disable DICT" OFF)
 mark_as_advanced(CURL_DISABLE_DICT)
-option(CURL_DISABLE_DOH "disables DNS-over-HTTPS" OFF)
+option(CURL_DISABLE_DOH "Disable DNS-over-HTTPS" OFF)
 mark_as_advanced(CURL_DISABLE_DOH)
-option(CURL_DISABLE_FILE "disables FILE" OFF)
+option(CURL_DISABLE_FILE "Disable FILE" OFF)
 mark_as_advanced(CURL_DISABLE_FILE)
-cmake_dependent_option(CURL_DISABLE_FORM_API "disables form api"
+cmake_dependent_option(CURL_DISABLE_FORM_API "Disable form-api"
   OFF "NOT CURL_DISABLE_MIME"
   ON)
 mark_as_advanced(CURL_DISABLE_FORM_API)
-option(CURL_DISABLE_FTP "disables FTP" OFF)
+option(CURL_DISABLE_FTP "Disable FTP" OFF)
 mark_as_advanced(CURL_DISABLE_FTP)
-option(CURL_DISABLE_GETOPTIONS "disables curl_easy_options API for existing options to curl_easy_setopt" OFF)
+option(CURL_DISABLE_GETOPTIONS "Disable curl_easy_options API for existing options to curl_easy_setopt" OFF)
 mark_as_advanced(CURL_DISABLE_GETOPTIONS)
-option(CURL_DISABLE_GOPHER "disables Gopher" OFF)
+option(CURL_DISABLE_GOPHER "Disable Gopher" OFF)
 mark_as_advanced(CURL_DISABLE_GOPHER)
-option(CURL_DISABLE_HEADERS_API "disables headers-api support" OFF)
+option(CURL_DISABLE_HEADERS_API "Disable headers-api support" OFF)
 mark_as_advanced(CURL_DISABLE_HEADERS_API)
-option(CURL_DISABLE_HSTS "disables HSTS support" OFF)
+option(CURL_DISABLE_HSTS "Disable HSTS support" OFF)
 mark_as_advanced(CURL_DISABLE_HSTS)
-option(CURL_DISABLE_HTTP "disables HTTP" OFF)
+option(CURL_DISABLE_HTTP "Disable HTTP" OFF)
 mark_as_advanced(CURL_DISABLE_HTTP)
-option(CURL_DISABLE_HTTP_AUTH "disables all HTTP authentication methods" OFF)
+option(CURL_DISABLE_HTTP_AUTH "Disable all HTTP authentication methods" OFF)
 mark_as_advanced(CURL_DISABLE_HTTP_AUTH)
-option(CURL_DISABLE_IMAP "disables IMAP" OFF)
+option(CURL_DISABLE_IMAP "Disable IMAP" OFF)
 mark_as_advanced(CURL_DISABLE_IMAP)
-option(CURL_DISABLE_LDAP "disables LDAP" OFF)
+option(CURL_DISABLE_LDAP "Disable LDAP" OFF)
 mark_as_advanced(CURL_DISABLE_LDAP)
-option(CURL_DISABLE_LDAPS "disables LDAPS" OFF)
+option(CURL_DISABLE_LDAPS "Disable LDAPS" OFF)
 mark_as_advanced(CURL_DISABLE_LDAPS)
-option(CURL_DISABLE_LIBCURL_OPTION "disables --libcurl option from the curl tool" OFF)
+option(CURL_DISABLE_LIBCURL_OPTION "Disable --libcurl option from the curl tool" OFF)
 mark_as_advanced(CURL_DISABLE_LIBCURL_OPTION)
-option(CURL_DISABLE_MIME "disables MIME support" OFF)
+option(CURL_DISABLE_MIME "Disable MIME support" OFF)
 mark_as_advanced(CURL_DISABLE_MIME)
-option(CURL_DISABLE_MQTT "disables MQTT" OFF)
+option(CURL_DISABLE_MQTT "Disable MQTT" OFF)
 mark_as_advanced(CURL_DISABLE_BINDLOCAL)
-option(CURL_DISABLE_BINDLOCAL "disables local binding support" OFF)
+option(CURL_DISABLE_BINDLOCAL "Disable local binding support" OFF)
 mark_as_advanced(CURL_DISABLE_MQTT)
-option(CURL_DISABLE_NETRC "disables netrc parser" OFF)
+option(CURL_DISABLE_NETRC "Disable netrc parser" OFF)
 mark_as_advanced(CURL_DISABLE_NETRC)
-option(CURL_DISABLE_NTLM "disables NTLM support" OFF)
+option(CURL_DISABLE_NTLM "Disable NTLM support" OFF)
 mark_as_advanced(CURL_DISABLE_NTLM)
-option(CURL_DISABLE_PARSEDATE "disables date parsing" OFF)
+option(CURL_DISABLE_PARSEDATE "Disable date parsing" OFF)
 mark_as_advanced(CURL_DISABLE_PARSEDATE)
-option(CURL_DISABLE_POP3 "disables POP3" OFF)
+option(CURL_DISABLE_POP3 "Disable POP3" OFF)
 mark_as_advanced(CURL_DISABLE_POP3)
-option(CURL_DISABLE_PROGRESS_METER "disables built-in progress meter" OFF)
+option(CURL_DISABLE_PROGRESS_METER "Disable built-in progress meter" OFF)
 mark_as_advanced(CURL_DISABLE_PROGRESS_METER)
-option(CURL_DISABLE_PROXY "disables proxy support" OFF)
+option(CURL_DISABLE_PROXY "Disable proxy support" OFF)
 mark_as_advanced(CURL_DISABLE_PROXY)
-option(CURL_DISABLE_RTSP "disables RTSP" OFF)
+option(CURL_DISABLE_RTSP "Disable RTSP" OFF)
 mark_as_advanced(CURL_DISABLE_RTSP)
-option(CURL_DISABLE_SHUFFLE_DNS "disables shuffle DNS feature" OFF)
+option(CURL_DISABLE_SHUFFLE_DNS "Disable shuffle DNS feature" OFF)
 mark_as_advanced(CURL_DISABLE_SHUFFLE_DNS)
-option(CURL_DISABLE_SMB "disables SMB" OFF)
+option(CURL_DISABLE_SMB "Disable SMB" OFF)
 mark_as_advanced(CURL_DISABLE_SMB)
-option(CURL_DISABLE_SMTP "disables SMTP" OFF)
+option(CURL_DISABLE_SMTP "Disable SMTP" OFF)
 mark_as_advanced(CURL_DISABLE_SMTP)
-option(CURL_DISABLE_SOCKETPAIR "disables use of socketpair for curl_multi_poll" OFF)
+option(CURL_DISABLE_SOCKETPAIR "Disable use of socketpair for curl_multi_poll" OFF)
 mark_as_advanced(CURL_DISABLE_SOCKETPAIR)
-option(CURL_DISABLE_TELNET "disables Telnet" OFF)
+option(CURL_DISABLE_TELNET "Disable Telnet" OFF)
 mark_as_advanced(CURL_DISABLE_TELNET)
-option(CURL_DISABLE_TFTP "disables TFTP" OFF)
+option(CURL_DISABLE_TFTP "Disable TFTP" OFF)
 mark_as_advanced(CURL_DISABLE_TFTP)
-option(CURL_DISABLE_VERBOSE_STRINGS "disables verbose strings" OFF)
+option(CURL_DISABLE_VERBOSE_STRINGS "Disable verbose strings" OFF)
 mark_as_advanced(CURL_DISABLE_VERBOSE_STRINGS)
 
 # Corresponds to HTTP_ONLY in lib/curl_setup.h
-option(HTTP_ONLY "disables all protocols except HTTP (This overrides all CURL_DISABLE_* options)" OFF)
+option(HTTP_ONLY "Disable all protocols except HTTP (This overrides all CURL_DISABLE_* options)" OFF)
 mark_as_advanced(HTTP_ONLY)
 
 if(HTTP_ONLY)
@@ -344,7 +344,7 @@ if(WINDOWS_STORE)
   set(CURL_DISABLE_TELNET ON)  # telnet code needs fixing to compile for UWP.
 endif()
 
-option(ENABLE_IPV6 "Define if you want to enable IPv6 support" ON)
+option(ENABLE_IPV6 "Enable IPv6 support" ON)
 mark_as_advanced(ENABLE_IPV6)
 if(ENABLE_IPV6 AND NOT WIN32)
   include(CheckStructHasMember)
@@ -356,7 +356,7 @@ if(ENABLE_IPV6 AND NOT WIN32)
     message(WARNING "struct sockaddr_in6 not available, disabling IPv6 support")
     # Force the feature off as this name is used as guard macro...
     set(ENABLE_IPV6 OFF
-        CACHE BOOL "Define if you want to enable IPv6 support" FORCE)
+        CACHE BOOL "Enable IPv6 support" FORCE)
   endif()
 
   if(APPLE AND NOT ENABLE_ARES)
@@ -377,9 +377,9 @@ endif()
 
 find_package(Perl)
 
-option(BUILD_LIBCURL_DOCS "to build libcurl man pages" ON)
-option(BUILD_MISC_DOCS "to build misc man pages (e.g. curl-config and mk-ca-bundle)" ON)
-option(ENABLE_CURL_MANUAL "to build the man page for curl and enable its -M/--manual option" ON)
+option(BUILD_LIBCURL_DOCS "Build libcurl man pages" ON)
+option(BUILD_MISC_DOCS "Build misc man pages (e.g. curl-config and mk-ca-bundle)" ON)
+option(ENABLE_CURL_MANUAL "Build the man page for curl and enable its -M/--manual option" ON)
 
 if(ENABLE_CURL_MANUAL OR BUILD_LIBCURL_DOCS)
   if(PERL_FOUND)
@@ -673,7 +673,7 @@ if(ZLIB_FOUND)
   list(APPEND CMAKE_REQUIRED_INCLUDES ${ZLIB_INCLUDE_DIRS})
 endif()
 
-option(CURL_BROTLI "Set to ON to enable building curl with brotli support." OFF)
+option(CURL_BROTLI "Use brotli" OFF)
 set(HAVE_BROTLI OFF)
 if(CURL_BROTLI)
   find_package(Brotli REQUIRED)
@@ -686,7 +686,7 @@ if(CURL_BROTLI)
   endif()
 endif()
 
-option(CURL_ZSTD "Set to ON to enable building curl with zstd support." OFF)
+option(CURL_ZSTD "Use zstd" OFF)
 set(HAVE_ZSTD OFF)
 if(CURL_ZSTD)
   find_package(Zstd REQUIRED)
@@ -1078,7 +1078,7 @@ if(NOT USE_LIBSSH2 AND CURL_USE_LIBSSH)
 endif()
 
 # wolfSSH
-option(CURL_USE_WOLFSSH "Use wolfssh" OFF)
+option(CURL_USE_WOLFSSH "Use wolfSSH" OFF)
 mark_as_advanced(CURL_USE_WOLFSSH)
 set(USE_WOLFSSH OFF)
 if(NOT USE_LIBSSH2 AND NOT USE_LIBSSH AND CURL_USE_WOLFSSH)
@@ -1206,7 +1206,7 @@ if(USE_LIBRTMP)
   endif()
 endif()
 
-option(ENABLE_UNIX_SOCKETS "Define if you want Unix domain sockets support" ON)
+option(ENABLE_UNIX_SOCKETS "Enable Unix domain sockets support" ON)
 if(ENABLE_UNIX_SOCKETS)
   if(WIN32)
     set(USE_UNIX_SOCKETS ON)
@@ -1558,7 +1558,7 @@ endif()
 
 set(CMAKE_REQUIRED_FLAGS)
 
-option(ENABLE_WEBSOCKETS "Set to ON to enable EXPERIMENTAL websockets" OFF)
+option(ENABLE_WEBSOCKETS "Enable WebSockets (experimental)" OFF)
 
 if(ENABLE_WEBSOCKETS)
   if(SIZEOF_CURL_OFF_T GREATER 4)