Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for adding extra flags to CMakeToolchain #3452

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Docs for adding extra flags to CMakeToolchain #3452

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee01751
add docs
czoido Nov 6, 2023
522a433
minor changes
czoido Nov 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions reference/tools/cmake/cmaketoolchain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,22 @@ following way:
tc.user_presets_path = False
tc.generate()

Extra compilation flags
^^^^^^^^^^^^^^^^^^^^^^^

You can use the following attributes to append extra compilation flags to the toolchain:

- **extra_cxxflags** (defaulted to ``[]``) for additional cxxflags
- **extra_cflags** (defaulted to ``[]``) for additional cflags
- **extra_sharedlinkflags** (defaulted to ``[]``) for additional shared link flags
- **extra_exelinkflags** (defaulted to ``[]``) for additional exe link flags

.. note::

**flags order of preference**: Flags specified in the `tools.build` configuration,
such as `cxxflags`, `cflags`, `sharedlinkflags` and `exelinkflags`, will
always take precedence over those set by the CMakeToolchain attributes.


presets_prefix
^^^^^^^^^^^^^^
Expand Down