]> git.ipfire.org Git - thirdparty/curl.git/commit
INSTALL-CMAKE.md: CMake usage updates
authorDerek Huang <djh458@stern.nyu.edu>
Fri, 14 Feb 2025 07:28:27 +0000 (02:28 -0500)
committerViktor Szakats <commit@vsz.me>
Tue, 25 Feb 2025 12:02:51 +0000 (13:02 +0100)
commitaf0100fc175c14b32ba5eac1a49880c32c4738cc
treee2549aaf021e53889d16b584606ca862bc0c3395
parent84332d49fb3594734507ab75509c19efb62c80fd
INSTALL-CMAKE.md: CMake usage updates

This PR updates the CMake build/install docs in `docs/INSTALL-CMAKE.md`,
in particular focusing on the use of libcurl from CMake using
`find_package` as well as the newly added features/protocols support via
using `COMPONENTS` or `OPTIONAL_COMPONENTS` with `find_package`.
See #15854 for initial discussion and the corresponding PR #15858 that
was merged.

Some additional best-practices notes are added, for example:

* Encouraging building out-of-source
* Using `--config` with `cmake --build` for multi-config CMake
  generators, not `CMAKE_BUILD_TYPE`

We also add a CURL CMake-specific tip on using `CMAKE_INSTALL_PREFIX`
during configure time to set the install prefix, not using `--prefix`
when running `cmake --install` so `curl-config` output is consistent.

Closes #16329
.github/scripts/spellcheck.words
docs/INSTALL-CMAKE.md