curl/CMake
Viktor Szakats f66af623cf
cmake: document -D and env build options
Extend `INSTALL-CMAKE` document with the list of available options,
a short description and default values.

The list may not be 100% complete.

There are no component boundaries in CMake, so the line is blurry
between curl options, CMake options, CMake Find modules options.
I included certain CMake options that seemed useful, and/or have
dedicated use withing curl's CMake source. But, all CMake built-in
options are usable, as documented upstream in CMake.

The naming of the options has a heritage and the inconsistencies with
it, including a lack of clear namespace. This may be subject to future
updates, also after figuring out which name has special meaning within
CMake and/or CMake projects out of unwritten convention or something
more tangible.

CMake allows to initialize any internal variable via `-D`. This may be
useful to pre-initialize/override feature check results. The list
doesn't contain these, and they remain officially undocumented.

Also:
- make adjustments to keep the spellchecker happy.
- retrofit description changes to the cmake sources.
- stop documenting deprecated `Find*` variables.

Reported-by: Daniel Stenberg
Fixes https://github.com/curl/curl/discussions/14885
Closes #15388
2024-10-24 23:06:40 +02:00
..
Platforms cmake: tidy-ups and rebase fixups 2024-10-12 22:33:29 +02:00
cmake_uninstall.cmake.in cmake: more small tidy-ups and fixes 2024-08-08 13:48:28 +02:00
CMakeConfigurableFile.in copyright: update all copyright lines and remove year ranges 2023-01-03 09:19:21 +01:00
curl-config.cmake.in cmake: tidy up 2024-09-22 09:51:15 +02:00
CurlSymbolHiding.cmake cmake: tidy up and shorten symbol hiding initialization 2024-10-24 22:12:58 +02:00
CurlTests.c cmake: apply WIN32_LEAN_AND_MEAN to all feature checks 2024-10-11 17:57:03 +02:00
FindBearSSL.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindBrotli.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindCares.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindGSS.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindLibgsasl.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindLibidn2.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindLibpsl.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindLibssh2.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindLibssh.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindLibuv.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindMbedTLS.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindMSH3.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindNettle.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindNGHTTP2.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindNGHTTP3.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindNGTCP2.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindQuiche.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindRustls.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindWolfSSH.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindWolfSSL.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
FindZstd.cmake cmake: document -D and env build options 2024-10-24 23:06:40 +02:00
Macros.cmake cmake: use list(APPEND) on CURL_INCLUDES 2024-10-24 19:16:10 +02:00
OtherTests.cmake cmake: use the BSD variable 2024-10-22 20:20:41 +02:00
PickyWarnings.cmake cmake: tidy up picky warning initialization 2024-10-24 21:20:04 +02:00
Utilities.cmake cmake: more syntax tidy-up 2024-08-07 23:41:27 +02:00