code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>SKIP_RETURN_CODE — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="TIMEOUT" href="TIMEOUT.html" />
    <link rel="prev" title="SKIP_REGULAR_EXPRESSION" href="SKIP_REGULAR_EXPRESSION.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

SKIP_RETURN_CODE

SKIP_RETURN_CODE¶

Return code to mark a test as skipped.

Sometimes only a test itself can determine if all requirements for the
test are met. If such a situation should not be considered a hard failure
a return code of the process can be specified that will mark the test as
Not Run if it is encountered. Valid values are in the range of
0 to 255, inclusive.

Tests that exceed the timeout specified by TIMEOUT still fail
regardless of SKIP_RETURN_CODE.
System-level test failures including segmentation faults,
signal abort, or heap errors may fail the test even if the return code matches.

# cmake (1) defines this to return code 1
add_test(NAME r1 COMMAND ${CMAKE_COMMAND} -E false)

set_tests_properties(r1 PROPERTIES SKIP_RETURN_CODE 1)

To run a test that may have a system-level failure, but still skip if
SKIP_RETURN_CODE matches, use a CMake command to wrap the executable run.
Note that this will prevent automatic handling of the
CROSSCOMPILING_EMULATOR and TEST_LAUNCHER target
property.

add_executable(main main.c)

# cmake -E env <command> returns 1 if the command fails in any way
add_test(NAME sigabrt COMMAND ${CMAKE_COMMAND} -E env $<TARGET_FILE:main>)

set_property(TEST sigabrt PROPERTY SKIP_RETURN_CODE 1)

#include <signal.h>

int main(void){ raise(SIGABRT); return 0; }

To handle multiple types of cases that may need to be skipped, consider the
SKIP_REGULAR_EXPRESSION property.

Previous topic

SKIP_REGULAR_EXPRESSION

Next topic

TIMEOUT

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

SKIP_RETURN_CODE

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>TIMEOUT — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="TIMEOUT_AFTER_MATCH" href="TIMEOUT_AFTER_MATCH.html" />
    <link rel="prev" title="SKIP_RETURN_CODE" href="SKIP_RETURN_CODE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT

TIMEOUT¶

How many seconds to allow for this test.

This property if set will limit a test to not take more than the
specified number of seconds to run.  If it exceeds that the test
process will be killed and ctest will move to the next test.  This
setting takes precedence over CTEST_TEST_TIMEOUT.

An explicit 0 value means the test has no timeout, except as
necessary to honor ctest --stop-time.

See also TIMEOUT_AFTER_MATCH and
TIMEOUT_SIGNAL_NAME.

Previous topic

SKIP_RETURN_CODE

Next topic

TIMEOUT_AFTER_MATCH

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.

repo_name: lazytadpole/codenamesilverfish

license: mit


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>TIMEOUT_AFTER_MATCH — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="TIMEOUT_SIGNAL_GRACE_PERIOD" href="TIMEOUT_SIGNAL_GRACE_PERIOD.html" />
    <link rel="prev" title="TIMEOUT" href="TIMEOUT.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT_AFTER_MATCH

TIMEOUT_AFTER_MATCH¶

New in version 3.6.

Change a test's timeout duration after a matching line is encountered
in its output.

Usage¶

add_test(mytest ...)
set_property(TEST mytest PROPERTY TIMEOUT_AFTER_MATCH "${seconds}" "${regex}")

Description¶

Allow a test seconds to complete after regex is encountered in
its output.

When the test outputs a line that matches regex its start time is
reset to the current time and its timeout duration is changed to
seconds.  Prior to this, the timeout duration is determined by the
TIMEOUT property or the CTEST_TEST_TIMEOUT
variable if either of these are set.  Because the test's start time is
reset, its execution time will not include any time that was spent
waiting for the matching output.

TIMEOUT_AFTER_MATCH is useful for avoiding spurious
timeouts when your test must wait for some system resource to become
available before it can execute.  Set TIMEOUT to a longer
duration that accounts for resource acquisition and use
TIMEOUT_AFTER_MATCH to control how long the actual test
is allowed to run.

If the required resource can be controlled by CTest you should use
RESOURCE_LOCK instead of TIMEOUT_AFTER_MATCH.
This property should be used when only the test itself can determine
when its required resources are available.

See also TIMEOUT_SIGNAL_NAME.

Table of Contents

TIMEOUT_AFTER_MATCH

Usage

Description

Previous topic

TIMEOUT

Next topic

TIMEOUT_SIGNAL_GRACE_PERIOD

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT_AFTER_MATCH

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>TIMEOUT_SIGNAL_GRACE_PERIOD — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="TIMEOUT_SIGNAL_NAME" href="TIMEOUT_SIGNAL_NAME.html" />
    <link rel="prev" title="TIMEOUT_AFTER_MATCH" href="TIMEOUT_AFTER_MATCH.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT_SIGNAL_GRACE_PERIOD

TIMEOUT_SIGNAL_GRACE_PERIOD¶

New in version 3.27.

If the TIMEOUT_SIGNAL_NAME test property is set, this property
specifies the number of seconds to wait for a test process to terminate after
sending the custom signal.  Otherwise, this property has no meaning.

The grace period may be any real value greater than 0.0, but not greater
than 60.0.  If this property is not set, the default is 1.0 second.

This is available only on platforms supporting POSIX signals.
It is not available on Windows.

Previous topic

TIMEOUT_AFTER_MATCH

Next topic

TIMEOUT_SIGNAL_NAME

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT_SIGNAL_GRACE_PERIOD

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>TIMEOUT_SIGNAL_NAME — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="WILL_FAIL" href="WILL_FAIL.html" />
    <link rel="prev" title="TIMEOUT_SIGNAL_GRACE_PERIOD" href="TIMEOUT_SIGNAL_GRACE_PERIOD.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT_SIGNAL_NAME

TIMEOUT_SIGNAL_NAME¶

New in version 3.27.

Specify a custom signal to send to a test process when its timeout is reached.
This is available only on platforms supporting POSIX signals.
It is not available on Windows.

The name must be one of the following:

SIGINT

Interrupt.

SIGQUIT

Quit.

SIGTERM

Terminate.

SIGUSR1

User defined signal 1.

SIGUSR2

User defined signal 2.

The custom signal is sent to the test process to give it a chance
to exit gracefully during a grace period:

If the test process created any children, it is responsible for
terminating them too.

The grace period length is determined by the
TIMEOUT_SIGNAL_GRACE_PERIOD test property.

If the test process does not terminate before the grace period ends,
ctest(1) will force termination of its entire process tree
via SIGSTOP and SIGKILL.

See also CTEST_TEST_TIMEOUT,
TIMEOUT, and TIMEOUT_AFTER_MATCH.

Previous topic

TIMEOUT_SIGNAL_GRACE_PERIOD

Next topic

WILL_FAIL

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

TIMEOUT_SIGNAL_NAME

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>WILL_FAIL — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="WORKING_DIRECTORY" href="WORKING_DIRECTORY.html" />
    <link rel="prev" title="TIMEOUT_SIGNAL_NAME" href="TIMEOUT_SIGNAL_NAME.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

WILL_FAIL

WILL_FAIL¶

If true, inverts the pass / fail test criteria. Tests for which
WILL_FAIL is true fail with return code 0 and pass with non-zero
return code. Tests that exceed the timeout specified by TIMEOUT
still fail regardless of WILL_FAIL.
System-level test failures including segmentation faults,
signal abort, or heap errors may fail the test even if WILL_FAIL is true.

Example of a test that would ordinarily pass, but fails because WILL_FAIL
is true:

add_test(NAME failed COMMAND ${CMAKE_COMMAND} -E true)
set_property(TEST failed PROPERTY WILL_FAIL true)

To run a test that may have a system-level failure, but still pass if
WILL_FAIL is set, use a CMake command to wrap the executable run.
Note that this will prevent automatic handling of the
CROSSCOMPILING_EMULATOR and TEST_LAUNCHER
target property.

add_executable(main main.c)

add_test(NAME sigabrt COMMAND ${CMAKE_COMMAND} -E env $<TARGET_FILE:main>)

set_property(TEST sigabrt PROPERTY WILL_FAIL TRUE)

#include <signal.h>

int main(void){ raise(SIGABRT); return 0; }

Previous topic

TIMEOUT_SIGNAL_NAME

Next topic

WORKING_DIRECTORY

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

WILL_FAIL

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>WORKING_DIRECTORY — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ABSTRACT" href="../prop_sf/ABSTRACT.html" />
    <link rel="prev" title="WILL_FAIL" href="WILL_FAIL.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

WORKING_DIRECTORY

WORKING_DIRECTORY¶

The directory from which the test executable will be called.

If this is not set, the test will be run with the working directory set to the
binary directory associated with where the test was created (i.e. the
CMAKE_CURRENT_BINARY_DIR for where add_test() was
called).

Previous topic

WILL_FAIL

Next topic

ABSTRACT

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

WORKING_DIRECTORY

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ADDITIONAL_CLEAN_FILES — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AIX_EXPORT_ALL_SYMBOLS" href="AIX_EXPORT_ALL_SYMBOLS.html" />
    <link rel="prev" title="VS_STARTUP_PROJECT" href="../prop_dir/VS_STARTUP_PROJECT.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ADDITIONAL_CLEAN_FILES

ADDITIONAL_CLEAN_FILES¶

New in version 3.15.

A ;-list of files or directories that will be
removed as a part of the global clean target.  It can be used to specify
files and directories that are generated as part of building the target or
that are directly associated with the target in some way (e.g. created as a
result of running the target).

For custom targets, if such files can be captured as outputs or byproducts
instead, then that should be preferred over adding them to this property.
If an additional clean file is used by multiple targets or isn't
target-specific, then the ADDITIONAL_CLEAN_FILES directory
property may be the more appropriate property to use.

Relative paths are allowed and are interpreted relative to the
current binary directory.

Contents of ADDITIONAL_CLEAN_FILES may use
generator expressions.

This property only works for the Ninja and the Makefile
generators.  It is ignored by other generators.

Previous topic

VS_STARTUP_PROJECT

Next topic

AIX_EXPORT_ALL_SYMBOLS

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ADDITIONAL_CLEAN_FILES

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AIX_EXPORT_ALL_SYMBOLS — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ALIAS_GLOBAL" href="ALIAS_GLOBAL.html" />
    <link rel="prev" title="ADDITIONAL_CLEAN_FILES" href="ADDITIONAL_CLEAN_FILES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AIX_EXPORT_ALL_SYMBOLS

AIX_EXPORT_ALL_SYMBOLS¶

New in version 3.17.

On AIX, CMake automatically exports all symbols from shared libraries, and
from executables with the ENABLE_EXPORTS target property set.
Explicitly disable this boolean property to suppress the behavior and
export no symbols by default.  In this case it is expected that the project
will use other means to export some symbols.

This property is initialized by the value of
the CMAKE_AIX_EXPORT_ALL_SYMBOLS variable if it is set
when a target is created.

Previous topic

ADDITIONAL_CLEAN_FILES

Next topic

ALIAS_GLOBAL

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AIX_EXPORT_ALL_SYMBOLS

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ALIASED_TARGET — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_ANT_ADDITIONAL_OPTIONS" href="ANDROID_ANT_ADDITIONAL_OPTIONS.html" />
    <link rel="prev" title="ALIAS_GLOBAL" href="ALIAS_GLOBAL.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ALIASED_TARGET

ALIASED_TARGET¶

Name of target aliased by this target.

If this is an Alias Target, this property contains
the name of the target aliased.

Previous topic

ALIAS_GLOBAL

Next topic

ANDROID_ANT_ADDITIONAL_OPTIONS

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ALIASED_TARGET

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ALIAS_GLOBAL — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ALIASED_TARGET" href="ALIASED_TARGET.html" />
    <link rel="prev" title="AIX_EXPORT_ALL_SYMBOLS" href="AIX_EXPORT_ALL_SYMBOLS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ALIAS_GLOBAL

ALIAS_GLOBAL¶

New in version 3.18.

Read-only property indicating of whether an ALIAS target
is globally visible.

The boolean value of this property is TRUE for aliases to
IMPORTED targets created
with the GLOBAL options to add_executable() or
add_library(), FALSE otherwise. It is undefined for
targets built within the project.

Note

Promoting an IMPORTED target from LOCAL
to GLOBAL scope by changing the value or IMPORTED_GLOBAL
target property do not change the scope of local aliases.

Previous topic

AIX_EXPORT_ALL_SYMBOLS

Next topic

ALIASED_TARGET

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ALIAS_GLOBAL

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_ANT_ADDITIONAL_OPTIONS — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_API" href="ANDROID_API.html" />
    <link rel="prev" title="ALIASED_TARGET" href="ALIASED_TARGET.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_ANT_ADDITIONAL_OPTIONS

ANDROID_ANT_ADDITIONAL_OPTIONS¶

New in version 3.4.

Set the additional options for Android Ant build system. This is
a string value containing all command line options for the Ant build.
This property is initialized by the value of the
CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS variable if it is
set when a target is created.

Previous topic

ALIASED_TARGET

Next topic

ANDROID_API

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_ANT_ADDITIONAL_OPTIONS

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_API — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_API_MIN" href="ANDROID_API_MIN.html" />
    <link rel="prev" title="ANDROID_ANT_ADDITIONAL_OPTIONS" href="ANDROID_ANT_ADDITIONAL_OPTIONS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_API

ANDROID_API¶

New in version 3.1.

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property sets the Android target API version (e.g. 15).
The version number must be a positive decimal integer.  This property is
initialized by the value of the CMAKE_ANDROID_API variable if
it is set when a target is created.

Previous topic

ANDROID_ANT_ADDITIONAL_OPTIONS

Next topic

ANDROID_API_MIN

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_API

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_API_MIN — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_ARCH" href="ANDROID_ARCH.html" />
    <link rel="prev" title="ANDROID_API" href="ANDROID_API.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_API_MIN

ANDROID_API_MIN¶

New in version 3.2.

Set the Android MIN API version (e.g. 9).  The version number
must be a positive decimal integer.  This property is initialized by
the value of the CMAKE_ANDROID_API_MIN variable if it is set
when a target is created.  Native code builds using this API version.

Previous topic

ANDROID_API

Next topic

ANDROID_ARCH

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_API_MIN

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_ARCH — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_ASSETS_DIRECTORIES" href="ANDROID_ASSETS_DIRECTORIES.html" />
    <link rel="prev" title="ANDROID_API_MIN" href="ANDROID_API_MIN.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_ARCH

ANDROID_ARCH¶

New in version 3.4.

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property sets the Android target architecture.

This is a string property that could be set to the one of
the following values:

armv7-a: "ARMv7-A (armv7-a)"

armv7-a-hard: "ARMv7-A, hard-float ABI (armv7-a)"

arm64-v8a: "ARMv8-A, 64bit (arm64-v8a)"

x86: "x86 (x86)"

x86_64: "x86_64 (x86_64)"

This property is initialized by the value of the
CMAKE_ANDROID_ARCH variable if it is set
when a target is created.

Previous topic

ANDROID_API_MIN

Next topic

ANDROID_ASSETS_DIRECTORIES

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_ARCH

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_ASSETS_DIRECTORIES — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_GUI" href="ANDROID_GUI.html" />
    <link rel="prev" title="ANDROID_ARCH" href="ANDROID_ARCH.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_ASSETS_DIRECTORIES

ANDROID_ASSETS_DIRECTORIES¶

New in version 3.4.

Set the Android assets directories to copy into the main assets
folder before build. This a string property that contains the
directory paths separated by semicolon.
This property is initialized by the value of the
CMAKE_ANDROID_ASSETS_DIRECTORIES variable if it is set when
a target is created.

Previous topic

ANDROID_ARCH

Next topic

ANDROID_GUI

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_ASSETS_DIRECTORIES

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_GUI — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_JAR_DEPENDENCIES" href="ANDROID_JAR_DEPENDENCIES.html" />
    <link rel="prev" title="ANDROID_ASSETS_DIRECTORIES" href="ANDROID_ASSETS_DIRECTORIES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_GUI

ANDROID_GUI¶

New in version 3.1.

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property specifies whether to build an executable as an
application package on Android.

When this property is set to true the executable when built for Android
will be created as an application package.  This property is initialized
by the value of the CMAKE_ANDROID_GUI variable if it is set
when a target is created.

Add the AndroidManifest.xml source file explicitly to the
target add_executable() command invocation to specify the
root directory of the application package source.

Previous topic

ANDROID_ASSETS_DIRECTORIES

Next topic

ANDROID_JAR_DEPENDENCIES

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_GUI

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_JAR_DEPENDENCIES — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_JAR_DIRECTORIES" href="ANDROID_JAR_DIRECTORIES.html" />
    <link rel="prev" title="ANDROID_GUI" href="ANDROID_GUI.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_JAR_DEPENDENCIES

ANDROID_JAR_DEPENDENCIES¶

New in version 3.4.

Set the Android property that specifies JAR dependencies.
This is a string value property. This property is initialized
by the value of the CMAKE_ANDROID_JAR_DEPENDENCIES
variable if it is set when a target is created.

Previous topic

ANDROID_GUI

Next topic

ANDROID_JAR_DIRECTORIES

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_JAR_DEPENDENCIES

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_JAR_DIRECTORIES — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_JAVA_SOURCE_DIR" href="ANDROID_JAVA_SOURCE_DIR.html" />
    <link rel="prev" title="ANDROID_JAR_DEPENDENCIES" href="ANDROID_JAR_DEPENDENCIES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_JAR_DIRECTORIES

ANDROID_JAR_DIRECTORIES¶

New in version 3.4.

Set the Android property that specifies directories to search for
the JAR libraries.

This a string property that contains the directory paths separated by
semicolons. This property is initialized by the value of the
CMAKE_ANDROID_JAR_DIRECTORIES variable if it is set when
a target is created.

Contents of ANDROID_JAR_DIRECTORIES may use "generator expressions"
with the syntax $<...>.  See the cmake-generator-expressions(7)
manual for available expressions.

Previous topic

ANDROID_JAR_DEPENDENCIES

Next topic

ANDROID_JAVA_SOURCE_DIR

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_JAR_DIRECTORIES

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_JAVA_SOURCE_DIR — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_NATIVE_LIB_DEPENDENCIES" href="ANDROID_NATIVE_LIB_DEPENDENCIES.html" />
    <link rel="prev" title="ANDROID_JAR_DIRECTORIES" href="ANDROID_JAR_DIRECTORIES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_JAVA_SOURCE_DIR

ANDROID_JAVA_SOURCE_DIR¶

New in version 3.4.

Set the Android property that defines the Java source code root directories.
This a string property that contains the directory paths separated by semicolon.
This property is initialized by the value of the
CMAKE_ANDROID_JAVA_SOURCE_DIR variable if it is set
when a target is created.

Previous topic

ANDROID_JAR_DIRECTORIES

Next topic

ANDROID_NATIVE_LIB_DEPENDENCIES

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_JAVA_SOURCE_DIR

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_NATIVE_LIB_DEPENDENCIES — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_NATIVE_LIB_DIRECTORIES" href="ANDROID_NATIVE_LIB_DIRECTORIES.html" />
    <link rel="prev" title="ANDROID_JAVA_SOURCE_DIR" href="ANDROID_JAVA_SOURCE_DIR.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_NATIVE_LIB_DEPENDENCIES

ANDROID_NATIVE_LIB_DEPENDENCIES¶

New in version 3.4.

Set the Android property that specifies the .so dependencies.
This is a string property.

This property is initialized by the value of the
CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES variable if it is set
when a target is created.

Contents of ANDROID_NATIVE_LIB_DEPENDENCIES may use
"generator expressions" with the syntax $<...>. See the
cmake-generator-expressions(7) manual for
available expressions.

Previous topic

ANDROID_JAVA_SOURCE_DIR

Next topic

ANDROID_NATIVE_LIB_DIRECTORIES

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_NATIVE_LIB_DEPENDENCIES

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_NATIVE_LIB_DIRECTORIES — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_PROCESS_MAX" href="ANDROID_PROCESS_MAX.html" />
    <link rel="prev" title="ANDROID_NATIVE_LIB_DEPENDENCIES" href="ANDROID_NATIVE_LIB_DEPENDENCIES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_NATIVE_LIB_DIRECTORIES

ANDROID_NATIVE_LIB_DIRECTORIES¶

New in version 3.4.

Set the Android property that specifies directories to search for the .so
libraries.

This a string property that contains the directory paths separated
by semicolons.

This property is initialized by the value of the
CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES variable if it is set when a
target is created.

Contents of ANDROID_NATIVE_LIB_DIRECTORIES may use "generator expressions"
with the syntax $<...>.  See the cmake-generator-expressions(7)
manual for available expressions.

Previous topic

ANDROID_NATIVE_LIB_DEPENDENCIES

Next topic

ANDROID_PROCESS_MAX

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_NATIVE_LIB_DIRECTORIES

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_PROCESS_MAX — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_PROGUARD" href="ANDROID_PROGUARD.html" />
    <link rel="prev" title="ANDROID_NATIVE_LIB_DIRECTORIES" href="ANDROID_NATIVE_LIB_DIRECTORIES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_PROCESS_MAX

ANDROID_PROCESS_MAX¶

New in version 3.4.

Set the Android property that defines the maximum number of a
parallel Android NDK compiler processes (e.g. 4).
This property is initialized by the value of the
CMAKE_ANDROID_PROCESS_MAX variable if it is set
when a target is created.

Previous topic

ANDROID_NATIVE_LIB_DIRECTORIES

Next topic

ANDROID_PROGUARD

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_PROCESS_MAX

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_PROGUARD — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_PROGUARD_CONFIG_PATH" href="ANDROID_PROGUARD_CONFIG_PATH.html" />
    <link rel="prev" title="ANDROID_PROCESS_MAX" href="ANDROID_PROCESS_MAX.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_PROGUARD

ANDROID_PROGUARD¶

New in version 3.4.

When this property is set to true that enables the ProGuard tool to shrink,
optimize, and obfuscate the code by removing unused code and renaming
classes, fields, and methods with semantically obscure names.
This property is initialized by the value of the
CMAKE_ANDROID_PROGUARD variable if it is set
when a target is created.

Previous topic

ANDROID_PROCESS_MAX

Next topic

ANDROID_PROGUARD_CONFIG_PATH

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_PROGUARD

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_PROGUARD_CONFIG_PATH — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_SECURE_PROPS_PATH" href="ANDROID_SECURE_PROPS_PATH.html" />
    <link rel="prev" title="ANDROID_PROGUARD" href="ANDROID_PROGUARD.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_PROGUARD_CONFIG_PATH

ANDROID_PROGUARD_CONFIG_PATH¶

New in version 3.4.

Set the Android property that specifies the location of the ProGuard
config file. Leave empty to use the default one.
This a string property that contains the path to ProGuard config file.
This property is initialized by the value of the
CMAKE_ANDROID_PROGUARD_CONFIG_PATH variable if it is set
when a target is created.

Previous topic

ANDROID_PROGUARD

Next topic

ANDROID_SECURE_PROPS_PATH

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_PROGUARD_CONFIG_PATH

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_SECURE_PROPS_PATH — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_SKIP_ANT_STEP" href="ANDROID_SKIP_ANT_STEP.html" />
    <link rel="prev" title="ANDROID_PROGUARD_CONFIG_PATH" href="ANDROID_PROGUARD_CONFIG_PATH.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_SECURE_PROPS_PATH

ANDROID_SECURE_PROPS_PATH¶

New in version 3.4.

Set the Android property that states the location of the secure properties file.
This is a string property that contains the file path.
This property is initialized by the value of the
CMAKE_ANDROID_SECURE_PROPS_PATH variable
if it is set when a target is created.

Previous topic

ANDROID_PROGUARD_CONFIG_PATH

Next topic

ANDROID_SKIP_ANT_STEP

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_SECURE_PROPS_PATH

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_SKIP_ANT_STEP — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ANDROID_STL_TYPE" href="ANDROID_STL_TYPE.html" />
    <link rel="prev" title="ANDROID_SECURE_PROPS_PATH" href="ANDROID_SECURE_PROPS_PATH.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_SKIP_ANT_STEP

ANDROID_SKIP_ANT_STEP¶

New in version 3.4.

Set the Android property that defines whether or not to skip the Ant build step.
This is a boolean property initialized by the value of the
CMAKE_ANDROID_SKIP_ANT_STEP variable if it is set when a target is created.

Previous topic

ANDROID_SECURE_PROPS_PATH

Next topic

ANDROID_STL_TYPE

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_SKIP_ANT_STEP

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ANDROID_STL_TYPE — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ARCHIVE_OUTPUT_DIRECTORY" href="ARCHIVE_OUTPUT_DIRECTORY.html" />
    <link rel="prev" title="ANDROID_SKIP_ANT_STEP" href="ANDROID_SKIP_ANT_STEP.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_STL_TYPE

ANDROID_STL_TYPE¶

New in version 3.4.

When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property specifies the type of STL support for the project.
This is a string property that could set to the one of the following values:

none

No C++ Support

system

Minimal C++ without STL

gabi++_static

GAbi++ Static

gabi++_shared

GAbi++ Shared

gnustl_static

GNU libstdc++ Static

gnustl_shared

GNU libstdc++ Shared

stlport_static

STLport Static

stlport_shared

STLport Shared

This property is initialized by the value of the
CMAKE_ANDROID_STL_TYPE variable if it is set when a target is
created.

Previous topic

ANDROID_SKIP_ANT_STEP

Next topic

ARCHIVE_OUTPUT_DIRECTORY

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ANDROID_STL_TYPE

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ARCHIVE_OUTPUT_DIRECTORY — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>" href="ARCHIVE_OUTPUT_DIRECTORY_CONFIG.html" />
    <link rel="prev" title="ANDROID_STL_TYPE" href="ANDROID_STL_TYPE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_DIRECTORY

ARCHIVE_OUTPUT_DIRECTORY¶

Output directory in which to build ARCHIVE target files.

This property specifies the directory into which archive target files
should be built.  The property value may use
generator expressions.
Multi-configuration generators (Visual Studio,
Xcode, Ninja Multi-Config) append a
per-configuration subdirectory to the specified directory unless a generator
expression is used.

This property is initialized by the value of the
CMAKE_ARCHIVE_OUTPUT_DIRECTORY variable if it is set when a target is created.

Note

On macOS, this property will be ignored for the linker import files (e.g.
.tbd files, see ENABLE_EXPORTS property for details) when:

The FRAMEWORK is set, because the framework layout cannot be
changed.

The Xcode generator is used, due to the limitations and
constraints of the Xcode tool.

In both cases, the linker import files will be generated in the same directory as the shared
library.

See also the ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> target property.

Previous topic

ANDROID_STL_TYPE

Next topic

ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_DIRECTORY

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ARCHIVE_OUTPUT_NAME" href="ARCHIVE_OUTPUT_NAME.html" />
    <link rel="prev" title="ARCHIVE_OUTPUT_DIRECTORY" href="ARCHIVE_OUTPUT_DIRECTORY.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>

<span id="prop_tgt:ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>">
ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>¶

Per-configuration output directory for
ARCHIVE target files.

This is a per-configuration version of the
ARCHIVE_OUTPUT_DIRECTORY target property, but
multi-configuration generators (VS, Xcode) do NOT append a
per-configuration subdirectory to the specified directory.  This
property is initialized by the value of the
CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> variable if
it is set when a target is created.

Contents of ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> may use
generator expressions.

Previous topic

ARCHIVE_OUTPUT_DIRECTORY

Next topic

ARCHIVE_OUTPUT_NAME

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ARCHIVE_OUTPUT_NAME — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="ARCHIVE_OUTPUT_NAME_<CONFIG>" href="ARCHIVE_OUTPUT_NAME_CONFIG.html" />
    <link rel="prev" title="ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>" href="ARCHIVE_OUTPUT_DIRECTORY_CONFIG.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_NAME

ARCHIVE_OUTPUT_NAME¶

Output name for ARCHIVE target files.

This property specifies the base name for archive target files.  It
overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG>
properties.

Note

On macOS, this property will be ignored for the linker import files (e.g.
.tbd files, see ENABLE_EXPORTS property for details) when:

The FRAMEWORK is set, because the framework layout cannot be
changed.

The Xcode generator is used, due to the limitations and
constraints of the Xcode tool.

In both cases, the linker import files will be generated with the same name as the shared
library.

See also the ARCHIVE_OUTPUT_NAME_<CONFIG> target property.

Previous topic

ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>

Next topic

ARCHIVE_OUTPUT_NAME_<CONFIG>

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_NAME

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>ARCHIVE_OUTPUT_NAME_<CONFIG> — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOGEN_BETTER_GRAPH_MULTI_CONFIG" href="AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.html" />
    <link rel="prev" title="ARCHIVE_OUTPUT_NAME" href="ARCHIVE_OUTPUT_NAME.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_NAME_<CONFIG>

<span id="prop_tgt:ARCHIVE_OUTPUT_NAME_<CONFIG>">
ARCHIVE_OUTPUT_NAME_<CONFIG>¶

Per-configuration output name for
ARCHIVE target files.

This is the configuration-specific version of the
ARCHIVE_OUTPUT_NAME target property.

Previous topic

ARCHIVE_OUTPUT_NAME

Next topic

AUTOGEN_BETTER_GRAPH_MULTI_CONFIG

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ARCHIVE_OUTPUT_NAME_<CONFIG>

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOGEN_BETTER_GRAPH_MULTI_CONFIG — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOGEN_BUILD_DIR" href="AUTOGEN_BUILD_DIR.html" />
    <link rel="prev" title="ARCHIVE_OUTPUT_NAME_<CONFIG>" href="ARCHIVE_OUTPUT_NAME_CONFIG.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_BETTER_GRAPH_MULTI_CONFIG

AUTOGEN_BETTER_GRAPH_MULTI_CONFIG¶

New in version 3.29.

AUTOGEN_BETTER_GRAPH_MULTI_CONFIG is a boolean property that can be set
on a target to have better dependency graph for multi-configuration generators.
When this property is enabled, CMake will generate more per-config targets.
Thus, the dependency graph will be more accurate for multi-configuration
generators and some recompilations will be avoided.

If the Qt version is 6.8 or newer, this property is enabled by default.
If the Qt version is older than 6.8, this property is disabled by default.
Consult the Qt documentation to check if the property can be enabled for older
Qt versions.

See the cmake-qt(7) manual for more information on using CMake
with Qt.

This property is initialized by the
CMAKE_AUTOGEN_BETTER_GRAPH_MULTI_CONFIG variable if it is set when
a target is created.

Previous topic

ARCHIVE_OUTPUT_NAME_<CONFIG>

Next topic

AUTOGEN_BUILD_DIR

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_BETTER_GRAPH_MULTI_CONFIG

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOGEN_BUILD_DIR — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOGEN_COMMAND_LINE_LENGTH_MAX" href="AUTOGEN_COMMAND_LINE_LENGTH_MAX.html" />
    <link rel="prev" title="AUTOGEN_BETTER_GRAPH_MULTI_CONFIG" href="AUTOGEN_BETTER_GRAPH_MULTI_CONFIG.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_BUILD_DIR

AUTOGEN_BUILD_DIR¶

New in version 3.9.

Directory where AUTOMOC, AUTOUIC and AUTORCC
generate files for the target.

The directory is created on demand and automatically added to the
ADDITIONAL_CLEAN_FILES target property.

When unset or empty the directory <dir>/<target-name>_autogen is used where
<dir> is CMAKE_CURRENT_BINARY_DIR and <target-name>
is NAME.

By default AUTOGEN_BUILD_DIR is unset.

See the cmake-qt(7) manual for more information on using CMake
with Qt.

Previous topic

AUTOGEN_BETTER_GRAPH_MULTI_CONFIG

Next topic

AUTOGEN_COMMAND_LINE_LENGTH_MAX

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_BUILD_DIR

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOGEN_COMMAND_LINE_LENGTH_MAX — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOGEN_ORIGIN_DEPENDS" href="AUTOGEN_ORIGIN_DEPENDS.html" />
    <link rel="prev" title="AUTOGEN_BUILD_DIR" href="AUTOGEN_BUILD_DIR.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_COMMAND_LINE_LENGTH_MAX

AUTOGEN_COMMAND_LINE_LENGTH_MAX¶

New in version 3.29.

Command line length limit for autogen targets, i.e. moc or uic,
that triggers the use of response files on Windows instead of passing all
arguments to the command line.

An empty (or unset) value sets the limit to 32000

A positive non zero integer value sets the exact command line length
limit.

By default AUTOGEN_COMMAND_LINE_LENGTH_MAX is initialized from
CMAKE_AUTOGEN_COMMAND_LINE_LENGTH_MAX.

See the cmake-qt(7) manual for more information on using CMake
with Qt.

Previous topic

AUTOGEN_BUILD_DIR

Next topic

AUTOGEN_ORIGIN_DEPENDS

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_COMMAND_LINE_LENGTH_MAX

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOGEN_ORIGIN_DEPENDS — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOGEN_PARALLEL" href="AUTOGEN_PARALLEL.html" />
    <link rel="prev" title="AUTOGEN_COMMAND_LINE_LENGTH_MAX" href="AUTOGEN_COMMAND_LINE_LENGTH_MAX.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_ORIGIN_DEPENDS

AUTOGEN_ORIGIN_DEPENDS¶

New in version 3.14.

Switch for forwarding origin target dependencies to the corresponding
The <ORIGIN>_autogen target target.

Note

If Qt 5.15 or later is used and the generator is either Ninja
or Makefile Generators, origin target dependencies are forwarded to
the The <ORIGIN>_autogen_timestamp_deps target target instead of
The <ORIGIN>_autogen target

Targets which have their AUTOMOC or AUTOUIC property
ON have a corresponding The <ORIGIN>_autogen target target which generates
moc and uic files.  As this The <ORIGIN>_autogen target target is created at
generate-time, it is not possible to define dependencies of it using
e.g.  add_dependencies().  Instead the AUTOGEN_ORIGIN_DEPENDS
target property decides whether the origin target dependencies should be
forwarded to the The <ORIGIN>_autogen target target or not.

By default AUTOGEN_ORIGIN_DEPENDS is initialized from
CMAKE_AUTOGEN_ORIGIN_DEPENDS which is ON by default.

In total the dependencies of the The <ORIGIN>_autogen target target are composed
from

forwarded origin target dependencies
(enabled by default via AUTOGEN_ORIGIN_DEPENDS)

additional user defined dependencies from AUTOGEN_TARGET_DEPENDS

See the cmake-qt(7) manual for more information on using CMake
with Qt.

Note

Disabling AUTOGEN_ORIGIN_DEPENDS is useful to avoid building of
origin target dependencies when building the The <ORIGIN>_autogen target target
only. This is especially interesting when a
global autogen target is enabled.

When the The <ORIGIN>_autogen target target doesn't require all the origin target's
dependencies, and AUTOGEN_ORIGIN_DEPENDS is disabled, it might be
necessary to extend AUTOGEN_TARGET_DEPENDS to add missing
dependencies.

Previous topic

AUTOGEN_COMMAND_LINE_LENGTH_MAX

Next topic

AUTOGEN_PARALLEL

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_ORIGIN_DEPENDS

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOGEN_PARALLEL — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOGEN_TARGET_DEPENDS" href="AUTOGEN_TARGET_DEPENDS.html" />
    <link rel="prev" title="AUTOGEN_ORIGIN_DEPENDS" href="AUTOGEN_ORIGIN_DEPENDS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_PARALLEL

AUTOGEN_PARALLEL¶

New in version 3.11.

Number of parallel moc or uic processes to start when using
AUTOMOC and AUTOUIC.

The custom The <ORIGIN>_autogen target target starts a number of threads of which
each one parses a source file and on demand starts a moc or uic
process. AUTOGEN_PARALLEL controls how many parallel threads
(and therefore moc or uic processes) are started.

An empty (or unset) value or the string AUTO sets the number of
threads/processes to the number of physical CPUs on the host system.

A positive non zero integer value sets the exact thread/process count.

Otherwise a single thread/process is started.

By default AUTOGEN_PARALLEL is initialized from
CMAKE_AUTOGEN_PARALLEL.

See the cmake-qt(7) manual for more information on using CMake
with Qt.

Previous topic

AUTOGEN_ORIGIN_DEPENDS

Next topic

AUTOGEN_TARGET_DEPENDS

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_PARALLEL

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOGEN_TARGET_DEPENDS — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOGEN_USE_SYSTEM_INCLUDE" href="AUTOGEN_USE_SYSTEM_INCLUDE.html" />
    <link rel="prev" title="AUTOGEN_PARALLEL" href="AUTOGEN_PARALLEL.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_TARGET_DEPENDS

AUTOGEN_TARGET_DEPENDS¶

Additional target dependencies of the corresponding The <ORIGIN>_autogen target
target.

Note

If Qt 5.15 or later is used and the generator is either Ninja
or Makefile Generators, additional target dependencies are added to
the The <ORIGIN>_autogen_timestamp_deps target target instead of the
The <ORIGIN>_autogen target target.

Targets which have their AUTOMOC or AUTOUIC property
ON have a corresponding The <ORIGIN>_autogen target  target which generates
moc and uic files.  As this The <ORIGIN>_autogen target  target is created
at generate-time, it is not possible to define dependencies of it using e.g.
add_dependencies().  Instead the AUTOGEN_TARGET_DEPENDS target
property can be set to a ;-list of additional
dependencies for the The <ORIGIN>_autogen target  target. Dependencies can be target
names or file names.

In total the dependencies of the The <ORIGIN>_autogen target  target are composed
from

forwarded origin target dependencies
(enabled by default via AUTOGEN_ORIGIN_DEPENDS)

additional user defined dependencies from AUTOGEN_TARGET_DEPENDS

See the cmake-qt(7) manual for more information on using CMake
with Qt.

Use cases¶

If AUTOMOC or AUTOUIC depends on a file that is either

a GENERATED non C++ file (e.g. a GENERATED .json
or .ui file) or

a GENERATED C++ file that isn't recognized by AUTOMOC
and AUTOUIC because it's skipped by SKIP_AUTOMOC,
SKIP_AUTOUIC, SKIP_AUTOGEN or CMP0071 or

a file that isn't in the origin target's sources

it must be added to AUTOGEN_TARGET_DEPENDS.

Table of Contents

AUTOGEN_TARGET_DEPENDS

Use cases

Previous topic

AUTOGEN_PARALLEL

Next topic

AUTOGEN_USE_SYSTEM_INCLUDE

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_TARGET_DEPENDS

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOGEN_USE_SYSTEM_INCLUDE — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOMOC" href="AUTOMOC.html" />
    <link rel="prev" title="AUTOGEN_TARGET_DEPENDS" href="AUTOGEN_TARGET_DEPENDS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_USE_SYSTEM_INCLUDE

AUTOGEN_USE_SYSTEM_INCLUDE¶

New in version 3.27.

AUTOGEN_USE_SYSTEM_INCLUDE is a boolean property that can be set
on a target to indicate that the autogen target include directory should
be added as a system include directory or normal include directory to the
target.

If this property is not set, the autogen target include directory is added
as a system include directory by default.  See policy CMP0151.

See the cmake-qt(7) manual for more information on using CMake
with Qt.

This property is initialized by the
CMAKE_AUTOGEN_USE_SYSTEM_INCLUDE variable if it is set when
a target is created.

Previous topic

AUTOGEN_TARGET_DEPENDS

Next topic

AUTOMOC

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOGEN_USE_SYSTEM_INCLUDE

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOMOC — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOMOC_COMPILER_PREDEFINES" href="AUTOMOC_COMPILER_PREDEFINES.html" />
    <link rel="prev" title="AUTOGEN_USE_SYSTEM_INCLUDE" href="AUTOGEN_USE_SYSTEM_INCLUDE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOMOC

AUTOMOC¶

Should the target be processed with auto-moc (for Qt projects).

AUTOMOC is a boolean specifying whether CMake will handle the Qt moc
preprocessor automatically, i.e.  without having to use commands like
QT4_WRAP_CPP(), qt5_wrap_cpp(), etc.
Currently, Qt versions 4 to 6 are supported.

This property is initialized by the value of the CMAKE_AUTOMOC
variable if it is set when a target is created.

When this property is set ON, CMake will scan the header and
source files at build time and invoke moc accordingly.

Header file processing¶

At configuration time, a list of header files that should be scanned by
AUTOMOC is computed from the target's sources.

All header files in the target's sources are added to the scan list.

For all C++ source files <source_base>.<source_extension> in the
target's sources, CMake searches for

a regular header with the same base name
(<source_base>.<header_extention>) and

a private header with the same base name and a _p suffix
(<source_base>_p.<header_extention>)

and adds these to the scan list.

At build time, CMake scans each unknown or modified header file from the
list and searches for

a Qt macro from AUTOMOC_MACRO_NAMES,

additional file dependencies from the FILE argument of a
Q_PLUGIN_METADATA macro and

additional file dependencies detected by filters defined in
AUTOMOC_DEPEND_FILTERS.

If a Qt macro is found, then the header will be compiled by the moc to the
output file moc_<base_name>.cpp.  The complete output file path is
described in the section Output file location.

The header will be moc compiled again if a file from the additional file
dependencies changes.

Header moc output files moc_<base_name>.cpp can be included in source
files.  In the section Including header moc files in sources there is more
information on that topic.

Source file processing¶

At build time, CMake scans each unknown or modified C++ source file from the
target's sources for

a Qt macro from AUTOMOC_MACRO_NAMES,

includes of header moc files
(see Including header moc files in sources),

additional file dependencies from the FILE argument of a
Q_PLUGIN_METADATA macro and

additional file dependencies detected by filters defined in
AUTOMOC_DEPEND_FILTERS.

If a Qt macro is found, then the C++ source file
<base>.<source_extension> is expected to as well contain an include
statement

#include <<base>.moc> // or
#include "<base>.moc"

The source file then will be compiled by the moc to the output file
<base>.moc.  A description of the complete output file path is in section
Output file location.

The source will be moc compiled again if a file from the additional file
dependencies changes.

Including header moc files in sources¶

A source file can include the moc output file of a header
<header_base>.<header_extension> by using an include statement of
the form

#include <moc_<header_base>.cpp> // or
#include "moc_<header_base>.cpp"

If the moc output file of a header is included by a source, it will
be generated in a different location than if it was not included.  This is
described in the section Output file location.

Output file location¶

Included moc output files¶

moc output files that are included by a source file will be generated in

<AUTOGEN_BUILD_DIR>/include
for single configuration generators or in

<AUTOGEN_BUILD_DIR>/include_<CONFIG>
for multi configuration generators.

Where <AUTOGEN_BUILD_DIR> is the value of the target property
AUTOGEN_BUILD_DIR.

The include directory is automatically added to the target's
INCLUDE_DIRECTORIES.

Not included moc output files¶

moc output files that are not included in a source file will be generated
in

<AUTOGEN_BUILD_DIR>/<SOURCE_DIR_CHECKSUM>
for single configuration generators or in,

<AUTOGEN_BUILD_DIR>/include_<CONFIG>/<SOURCE_DIR_CHECKSUM>
for multi configuration generators.

Where <SOURCE_DIR_CHECKSUM> is a checksum computed from the relative
parent directory path of the moc input file.  This scheme allows to have
moc input files with the same name in different directories.

All not included moc output files will be included automatically by the
CMake generated file

<AUTOGEN_BUILD_DIR>/mocs_compilation.cpp, or

<AUTOGEN_BUILD_DIR>/mocs_compilation_$<CONFIG>.cpp,

which is added to the target's sources.

Qt version detection¶

AUTOMOC enabled targets need to know the Qt major and minor
version they're working with.  The major version usually is provided by the
INTERFACE_QT_MAJOR_VERSION property of the Qt[456]Core library,
that the target links to.  To find the minor version, CMake builds a list of
available Qt versions from

Qt6Core_VERSION_MAJOR and Qt6Core_VERSION_MINOR variables
(usually set by find_package(Qt6...))

Qt6Core_VERSION_MAJOR and Qt6Core_VERSION_MINOR directory properties

Qt5Core_VERSION_MAJOR and Qt5Core_VERSION_MINOR variables
(usually set by find_package(Qt5...))

Qt5Core_VERSION_MAJOR and Qt5Core_VERSION_MINOR directory properties

QT_VERSION_MAJOR and QT_VERSION_MINOR  variables
(usually set by find_package(Qt4...))

QT_VERSION_MAJOR and QT_VERSION_MINOR  directory properties

in the context of the add_executable() or add_library() call.

Assumed  INTERFACE_QT_MAJOR_VERSION is a valid number, the first
entry in the list with a matching major version is taken.  If no matching major
version was found, an error is generated.
If  INTERFACE_QT_MAJOR_VERSION is not a valid number, the first
entry in the list is taken.

A find_package(Qt[456]...) call sets the QT/Qt[56]Core_VERSION_MAJOR/MINOR
variables.  If the call is in a different context than the
add_executable() or add_library() call, e.g. in a function,
then the version variables might not be available to the AUTOMOC
enabled target.
In that case the version variables can be forwarded from the
find_package(Qt[456]...) calling context to the add_executable()
or add_library() calling context as directory properties.
The following Qt5 example demonstrates the procedure.

function (add_qt5_client)
  find_package(Qt5 REQUIRED QUIET COMPONENTS Core Widgets)
  ...
  set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    PROPERTY Qt5Core_VERSION_MAJOR "${Qt5Core_VERSION_MAJOR}")
  set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    PROPERTY Qt5Core_VERSION_MINOR "${Qt5Core_VERSION_MAJOR}")
  ...
endfunction ()
...
add_qt5_client()
add_executable(myTarget main.cpp)
target_link_libraries(myTarget Qt5::QtWidgets)
set_property(TARGET myTarget PROPERTY AUTOMOC ON)

Modifiers¶

AUTOMOC_EXECUTABLE:
The moc executable will be detected automatically, but can be forced to
a certain binary using this target property.

AUTOMOC_MOC_OPTIONS:
Additional command line options for moc can be set in this target property.

AUTOMOC_MACRO_NAMES:
This list of Qt macro names can be extended to search for additional macros in
headers and sources.

AUTOMOC_DEPEND_FILTERS:
moc dependency file names can be extracted from headers or sources by
defining file name filters in this target property.

AUTOMOC_COMPILER_PREDEFINES:
Compiler pre definitions for moc are written to the moc_predefs.h file.
The generation of this file can be enabled or disabled in this target property.

SKIP_AUTOMOC:
Sources and headers can be excluded from AUTOMOC processing by
setting this source file property.

SKIP_AUTOGEN:
Source files can be excluded from AUTOMOC,
AUTOUIC and AUTORCC processing by
setting this source file property.

AUTOGEN_SOURCE_GROUP:
This global property can be used to group files generated by
AUTOMOC or AUTORCC together in an IDE, e.g.  in MSVS.

AUTOGEN_TARGETS_FOLDER:
This global property can be used to group AUTOMOC,
AUTOUIC and AUTORCC targets together in an IDE,
e.g.  in MSVS.

CMAKE_GLOBAL_AUTOGEN_TARGET:
A global autogen target, that depends on all AUTOMOC or
AUTOUIC generated The <ORIGIN>_autogen target targets in the project,
will be generated when this variable is ON.

AUTOGEN_PARALLEL:
This target property controls the number of moc or uic processes to
start in parallel during builds.

AUTOGEN_COMMAND_LINE_LENGTH_MAX:
This target property controls the limit when to use response files for
moc or uic processes on Windows.

See the cmake-qt(7) manual for more information on using CMake
with Qt.

Table of Contents

AUTOMOC

Header file processing

Source file processing

Including header moc files in sources

Output file location

Included moc output files

Not included moc output files

Qt version detection

Modifiers

Previous topic

AUTOGEN_USE_SYSTEM_INCLUDE

Next topic

AUTOMOC_COMPILER_PREDEFINES

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOMOC

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>AUTOMOC_COMPILER_PREDEFINES — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AUTOMOC_DEPEND_FILTERS" href="AUTOMOC_DEPEND_FILTERS.html" />
    <link rel="prev" title="AUTOMOC" href="AUTOMOC.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOMOC_COMPILER_PREDEFINES

AUTOMOC_COMPILER_PREDEFINES¶

New in version 3.10.

Boolean value used by AUTOMOC to determine if the
compiler pre definitions file moc_predefs.h should be generated.

CMake generates a moc_predefs.h file with compiler pre definitions
from the output of the command defined in
CMAKE_CXX_COMPILER_PREDEFINES_COMMAND
when

AUTOMOC is enabled,

AUTOMOC_COMPILER_PREDEFINES is enabled,

CMAKE_CXX_COMPILER_PREDEFINES_COMMAND isn't empty and

the Qt version is greater or equal 5.8.

The moc_predefs.h file, which is generated in AUTOGEN_BUILD_DIR,
is passed to moc as the argument to the --include option.

By default AUTOMOC_COMPILER_PREDEFINES is initialized from
CMAKE_AUTOMOC_COMPILER_PREDEFINES, which is ON by default.

See the cmake-qt(7) manual for more information on using CMake
with Qt.

Previous topic

AUTOMOC

Next topic

AUTOMOC_DEPEND_FILTERS

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

AUTOMOC_COMPILER_PREDEFINES

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.