curl/docs
Viktor Szakats 45202cbba4
cmake: separate target for examples, optimize CI, fix fallouts
- Move `docs/examples` builds under a separate target.

- Make `BUILD_EXAMPLES` default to `ON`. It means to generate the rules
  for `docs/examples` by default, but not build them. To build them,
  an explicit `make curl-examples` (or ninja, etc) command is necessary.
  This syncs behaviour with autotools, and also how both cmake and
  autotools are building tests.

- GHA: update cmake jobs to use the new way of building examples.

- GHA: move examples build step at the end of the job, after building
  and running tests. This allows to have build and test run results
  faster, and leave the seldom-changing examples build to the end.
  Building examples is the slowest build step with no practical way to
  make them fast.

- appveyor: enable building examples in two old-MSVC jobs.

- examples: fix examples to build cleanly with old MSVC versions.

- GHA/non-native: move example build log under a GHA foldable section.

- GHA/windows: move building examples into separate step for Linux cross
  jobs.

Follow-up to dfdd978f7c #13491
Closes #14906
2024-09-20 23:53:33 +02:00
..
cmdline-opts
examples
internals
libcurl
.gitignore
BINDINGS.md
BUG-BOUNTY.md
BUGS.md
CIPHERS-TLS12.md
CIPHERS.md
CMakeLists.txt
CODE_OF_CONDUCT.md
CODE_REVIEW.md
CONTRIBUTE.md
curl-config.md
CURL-DISABLE.md
CURLDOWN.md
DEPRECATE.md
DISTROS.md
EARLY-RELEASE.md
ECH.md
EXPERIMENTAL.md
FAQ
FEATURES.md
GOVERNANCE.md
HELP-US.md
HISTORY.md
HTTP3.md
HTTP-COOKIES.md
INSTALL
INSTALL-CMAKE.md
INSTALL.md
INTERNALS.md
IPFS.md
KNOWN_BUGS
MAIL-ETIQUETTE.md
Makefile.am
MANUAL.md
mk-ca-bundle.md
options-in-versions
README.md
RELEASE-PROCEDURE.md
ROADMAP.md
RUSTLS.md
SECURITY-ADVISORY.md
SPONSORS.md
SSL-PROBLEMS.md
SSLCERTS.md
THANKS
THANKS-filter
TheArtOfHttpScripting.md
TODO
URL-SYNTAX.md
VERSIONS.md
VULN-DISCLOSURE-POLICY.md

curl logo

Documentation

You find a mix of various documentation in this directory and subdirectories, using several different formats. Some of them are not ideal for reading directly in your browser.

If you would rather see the rendered version of the documentation, check out the curl website's documentation section for general curl stuff or the libcurl section for libcurl related documentation.