mirror of
https://github.com/Kitware/CMake.git
synced 2025-10-14 02:08:27 +08:00
ac67631b02
- Added intro code blocks showing how to include these modules.
- Used word "command" instead of "macro".
- Added examples sections.
- Updated and synced descriptions of commands and arguments.
- Added a rubric title for variables that affect the checks.
- Listed CMAKE_TRY_COMPILE_TARGET_TYPE variable in the rubric together
with CMAKE_REQUIRED_* variables.
- Added link to CheckCompilerFlag module in the target_compile_options()
docs.
- Used lowercase style for check_fortran_compiler_flag() command.
- Added a link to `$<COMPILE_LANGUAGE:languages>` generator expression
so it can be linked from other pages (See commit
2e37a20f02 for more info on the initial
style used).
- Fixed the GENEX_NOTE inclusion (starting with line after the 2nd line)
where part of the sentence was rendered in the output.
69 lines
1.9 KiB
ReStructuredText
69 lines
1.9 KiB
ReStructuredText
add_compile_options
|
|
-------------------
|
|
|
|
Add options to the compilation of source files.
|
|
|
|
.. code-block:: cmake
|
|
|
|
add_compile_options(<option> ...)
|
|
|
|
Adds options to the :prop_dir:`COMPILE_OPTIONS` directory property.
|
|
These options are used when compiling targets from the current
|
|
directory and below.
|
|
|
|
.. note::
|
|
|
|
These options are not used when linking.
|
|
See the :command:`add_link_options` command for that.
|
|
|
|
Arguments
|
|
^^^^^^^^^
|
|
|
|
.. |command_name| replace:: ``add_compile_options``
|
|
.. include:: include/GENEX_NOTE.rst
|
|
|
|
.. include:: include/OPTIONS_SHELL.rst
|
|
|
|
Example
|
|
^^^^^^^
|
|
|
|
Since different compilers support different options, a typical use of
|
|
this command is in a compiler-specific conditional clause:
|
|
|
|
.. code-block:: cmake
|
|
|
|
if (MSVC)
|
|
# warning level 4
|
|
add_compile_options(/W4)
|
|
else()
|
|
# additional warnings
|
|
add_compile_options(-Wall -Wextra -Wpedantic)
|
|
endif()
|
|
|
|
To set per-language options, use the :genex:`$<COMPILE_LANGUAGE>`
|
|
or :genex:`$<COMPILE_LANGUAGE:languages> <COMPILE_LANGUAGE:languages>`
|
|
generator expressions.
|
|
|
|
See Also
|
|
^^^^^^^^
|
|
|
|
* This command can be used to add any options. However, for
|
|
adding preprocessor definitions and include directories it is recommended
|
|
to use the more specific commands :command:`add_compile_definitions`
|
|
and :command:`include_directories`.
|
|
|
|
* The command :command:`target_compile_options` adds target-specific options.
|
|
|
|
* This command adds compile options for all languages.
|
|
Use the :genex:`COMPILE_LANGUAGE` generator expression to specify
|
|
per-language compile options.
|
|
|
|
* The source file property :prop_sf:`COMPILE_OPTIONS` adds options to one
|
|
source file.
|
|
|
|
* :command:`add_link_options` adds options for linking.
|
|
|
|
* :variable:`CMAKE_<LANG>_FLAGS` and :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>`
|
|
add language-wide flags passed to all invocations of the compiler.
|
|
This includes invocations that drive compiling and those that drive linking.
|