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>UNITY_GROUP — 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="VS_COPY_TO_OUT_DIR" href="VS_COPY_TO_OUT_DIR.html" />
    <link rel="prev" title="SYMBOLIC" href="SYMBOLIC.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

UNITY_GROUP

UNITY_GROUP¶

New in version 3.18.

This property controls which bucket the source will be part of when
the UNITY_BUILD_MODE is set to GROUP.

Previous topic

SYMBOLIC

Next topic

VS_COPY_TO_OUT_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) »

UNITY_GROUP

        © 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>VS_COPY_TO_OUT_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="VS_CSHARP_<tagname>" href="VS_CSHARP_tagname.html" />
    <link rel="prev" title="UNITY_GROUP" href="UNITY_GROUP.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_COPY_TO_OUT_DIR

VS_COPY_TO_OUT_DIR¶

New in version 3.8.

Sets the <CopyToOutputDirectory> tag for a source file in a
Visual Studio project file. Valid values are Never, Always
and PreserveNewest.

Previous topic

UNITY_GROUP

Next topic

VS_CSHARP_<tagname>

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) »

VS_COPY_TO_OUT_DIR

        © 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>VS_CSHARP_<tagname> — 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="VS_DEPLOYMENT_CONTENT" href="VS_DEPLOYMENT_CONTENT.html" />
    <link rel="prev" title="VS_COPY_TO_OUT_DIR" href="VS_COPY_TO_OUT_DIR.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_CSHARP_<tagname>

<span id="prop_sf:VS_CSHARP_<tagname>">
VS_CSHARP_<tagname>¶

New in version 3.8.

Visual Studio and CSharp source-file-specific configuration.

Tell the Visual Studio generators
to set the source file tag <tagname>
to a given value in the generated Visual Studio CSharp
project. Ignored on other generators and languages. This property
can be used to define dependencies between source files or set any
other Visual Studio specific parameters.

Example usage:

set_source_files_properties(<filename>
         PROPERTIES
         VS_CSHARP_DependentUpon <other file>
         VS_CSHARP_SubType "Form")

Previous topic

VS_COPY_TO_OUT_DIR

Next topic

VS_DEPLOYMENT_CONTENT

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) »

VS_CSHARP_<tagname>

        © 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>VS_DEPLOYMENT_CONTENT — 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="VS_DEPLOYMENT_LOCATION" href="VS_DEPLOYMENT_LOCATION.html" />
    <link rel="prev" title="VS_CSHARP_<tagname>" href="VS_CSHARP_tagname.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_DEPLOYMENT_CONTENT

VS_DEPLOYMENT_CONTENT¶

New in version 3.1.

Mark a source file as content for deployment with a Windows Phone or
Windows Store application when built with a
Visual Studio generators.
The value must evaluate to either 1 or 0 and may use
generator expressions
to make the choice based on the build configuration.
The .vcxproj file entry for the source file will be
marked either DeploymentContent or ExcludedFromBuild
for values 1 and 0, respectively.

Previous topic

VS_CSHARP_<tagname>

Next topic

VS_DEPLOYMENT_LOCATION

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) »

VS_DEPLOYMENT_CONTENT

        © 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>VS_DEPLOYMENT_LOCATION — 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="VS_INCLUDE_IN_VSIX" href="VS_INCLUDE_IN_VSIX.html" />
    <link rel="prev" title="VS_DEPLOYMENT_CONTENT" href="VS_DEPLOYMENT_CONTENT.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_DEPLOYMENT_LOCATION

VS_DEPLOYMENT_LOCATION¶

New in version 3.1.

Specifies the deployment location for a content source file with a Windows
Phone or Windows Store application when built
with a Visual Studio generators.
This property is only applicable when using VS_DEPLOYMENT_CONTENT.
The value represent the path relative to the app package and applies to all
configurations.

Previous topic

VS_DEPLOYMENT_CONTENT

Next topic

VS_INCLUDE_IN_VSIX

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) »

VS_DEPLOYMENT_LOCATION

        © 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>VS_INCLUDE_IN_VSIX — 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="VS_RESOURCE_GENERATOR" href="VS_RESOURCE_GENERATOR.html" />
    <link rel="prev" title="VS_DEPLOYMENT_LOCATION" href="VS_DEPLOYMENT_LOCATION.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_INCLUDE_IN_VSIX

VS_INCLUDE_IN_VSIX¶

New in version 3.8.

Boolean property to specify if the file should be included within a
VSIX (Visual Studio Integration Extension) extension package.
This is needed for development of Visual Studio extensions.

Previous topic

VS_DEPLOYMENT_LOCATION

Next topic

VS_RESOURCE_GENERATOR

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) »

VS_INCLUDE_IN_VSIX

        © 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>VS_RESOURCE_GENERATOR — 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="VS_SETTINGS" href="VS_SETTINGS.html" />
    <link rel="prev" title="VS_INCLUDE_IN_VSIX" href="VS_INCLUDE_IN_VSIX.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_RESOURCE_GENERATOR

VS_RESOURCE_GENERATOR¶

New in version 3.8.

This property allows to specify the resource generator to be used
on this file. It defaults to PublicResXFileCodeGenerator if
not set.

This property only applies to C# projects.

Previous topic

VS_INCLUDE_IN_VSIX

Next topic

VS_SETTINGS

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) »

VS_RESOURCE_GENERATOR

        © 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>VS_SETTINGS — 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="VS_SHADER_DISABLE_OPTIMIZATIONS" href="VS_SHADER_DISABLE_OPTIMIZATIONS.html" />
    <link rel="prev" title="VS_RESOURCE_GENERATOR" href="VS_RESOURCE_GENERATOR.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SETTINGS

VS_SETTINGS¶

New in version 3.18.

Set any item metadata on a file.

New in version 3.22: This property is honored for all source file types.
Previously it worked only for non-built files.

Takes a list of Key=Value pairs. Tells the Visual Studio generator to set
Key to Value as item metadata on the file.

For example:

set_property(SOURCE file.hlsl PROPERTY VS_SETTINGS "Key=Value" "Key2=Value2")

will set Key to Value and Key2 to Value2 on the
file.hlsl item as metadata.

Generator expressions are supported.

Previous topic

VS_RESOURCE_GENERATOR

Next topic

VS_SHADER_DISABLE_OPTIMIZATIONS

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) »

VS_SETTINGS

        © 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>VS_SHADER_DISABLE_OPTIMIZATIONS — 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="VS_SHADER_ENABLE_DEBUG" href="VS_SHADER_ENABLE_DEBUG.html" />
    <link rel="prev" title="VS_SETTINGS" href="VS_SETTINGS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_DISABLE_OPTIMIZATIONS

VS_SHADER_DISABLE_OPTIMIZATIONS¶

New in version 3.11.

Disable compiler optimizations for an .hlsl source file.  This adds the
-Od flag to the command line for the FxCompiler tool.  Specify the value
true for this property to disable compiler optimizations.

Previous topic

VS_SETTINGS

Next topic

VS_SHADER_ENABLE_DEBUG

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) »

VS_SHADER_DISABLE_OPTIMIZATIONS

        © 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>VS_SHADER_ENABLE_DEBUG — 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="VS_SHADER_ENTRYPOINT" href="VS_SHADER_ENTRYPOINT.html" />
    <link rel="prev" title="VS_SHADER_DISABLE_OPTIMIZATIONS" href="VS_SHADER_DISABLE_OPTIMIZATIONS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_ENABLE_DEBUG

VS_SHADER_ENABLE_DEBUG¶

New in version 3.11.

Enable debugging information for an .hlsl source file.  This adds the
-Zi flag to the command line for the FxCompiler tool.  Specify the value
true to generate debugging information for the compiled shader.

Previous topic

VS_SHADER_DISABLE_OPTIMIZATIONS

Next topic

VS_SHADER_ENTRYPOINT

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) »

VS_SHADER_ENABLE_DEBUG

        © 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>VS_SHADER_ENTRYPOINT — 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="VS_SHADER_FLAGS" href="VS_SHADER_FLAGS.html" />
    <link rel="prev" title="VS_SHADER_ENABLE_DEBUG" href="VS_SHADER_ENABLE_DEBUG.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_ENTRYPOINT

VS_SHADER_ENTRYPOINT¶

New in version 3.1.

Specifies the name of the entry point for the shader of a .hlsl source
file.

Previous topic

VS_SHADER_ENABLE_DEBUG

Next topic

VS_SHADER_FLAGS

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) »

VS_SHADER_ENTRYPOINT

        © 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>VS_SHADER_FLAGS — 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="VS_SHADER_MODEL" href="VS_SHADER_MODEL.html" />
    <link rel="prev" title="VS_SHADER_ENTRYPOINT" href="VS_SHADER_ENTRYPOINT.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_FLAGS

VS_SHADER_FLAGS¶

New in version 3.2.

Set additional Visual Studio shader flags of a .hlsl source file.

Previous topic

VS_SHADER_ENTRYPOINT

Next topic

VS_SHADER_MODEL

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) »

VS_SHADER_FLAGS

        © 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>VS_SHADER_MODEL — 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="VS_SHADER_OBJECT_FILE_NAME" href="VS_SHADER_OBJECT_FILE_NAME.html" />
    <link rel="prev" title="VS_SHADER_FLAGS" href="VS_SHADER_FLAGS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_MODEL

VS_SHADER_MODEL¶

New in version 3.1.

Specifies the shader model of a .hlsl source file. Some shader types can
only be used with recent shader models

Previous topic

VS_SHADER_FLAGS

Next topic

VS_SHADER_OBJECT_FILE_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) »

VS_SHADER_MODEL

        © 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>VS_SHADER_OBJECT_FILE_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="VS_SHADER_OUTPUT_HEADER_FILE" href="VS_SHADER_OUTPUT_HEADER_FILE.html" />
    <link rel="prev" title="VS_SHADER_MODEL" href="VS_SHADER_MODEL.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_OBJECT_FILE_NAME

VS_SHADER_OBJECT_FILE_NAME¶

New in version 3.12.

Specifies a file name for the compiled shader object file for an .hlsl
source file.  This adds the -Fo flag to the command line for the FxCompiler
tool.

Previous topic

VS_SHADER_MODEL

Next topic

VS_SHADER_OUTPUT_HEADER_FILE

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) »

VS_SHADER_OBJECT_FILE_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>VS_SHADER_OUTPUT_HEADER_FILE — 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="VS_SHADER_TYPE" href="VS_SHADER_TYPE.html" />
    <link rel="prev" title="VS_SHADER_OBJECT_FILE_NAME" href="VS_SHADER_OBJECT_FILE_NAME.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_OUTPUT_HEADER_FILE

VS_SHADER_OUTPUT_HEADER_FILE¶

New in version 3.10.

Set filename for output header file containing object code of a .hlsl
source file.

Previous topic

VS_SHADER_OBJECT_FILE_NAME

Next topic

VS_SHADER_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) »

VS_SHADER_OUTPUT_HEADER_FILE

        © 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>VS_SHADER_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="VS_SHADER_VARIABLE_NAME" href="VS_SHADER_VARIABLE_NAME.html" />
    <link rel="prev" title="VS_SHADER_OUTPUT_HEADER_FILE" href="VS_SHADER_OUTPUT_HEADER_FILE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_TYPE

VS_SHADER_TYPE¶

New in version 3.1.

Set the Visual Studio shader type of a .hlsl source file.

Previous topic

VS_SHADER_OUTPUT_HEADER_FILE

Next topic

VS_SHADER_VARIABLE_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) »

VS_SHADER_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>VS_SHADER_VARIABLE_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="VS_TOOL_OVERRIDE" href="VS_TOOL_OVERRIDE.html" />
    <link rel="prev" title="VS_SHADER_TYPE" href="VS_SHADER_TYPE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_SHADER_VARIABLE_NAME

VS_SHADER_VARIABLE_NAME¶

New in version 3.10.

Set name of variable in header file containing object code of a .hlsl
source file.

Previous topic

VS_SHADER_TYPE

Next topic

VS_TOOL_OVERRIDE

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) »

VS_SHADER_VARIABLE_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>VS_TOOL_OVERRIDE — 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="VS_XAML_TYPE" href="VS_XAML_TYPE.html" />
    <link rel="prev" title="VS_SHADER_VARIABLE_NAME" href="VS_SHADER_VARIABLE_NAME.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_TOOL_OVERRIDE

VS_TOOL_OVERRIDE¶

New in version 3.7.

Override the default Visual Studio tool that will be applied to the source file
with a new tool not based on the extension of the file.

Previous topic

VS_SHADER_VARIABLE_NAME

Next topic

VS_XAML_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) »

VS_TOOL_OVERRIDE

        © 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>VS_XAML_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="WRAP_EXCLUDE" href="WRAP_EXCLUDE.html" />
    <link rel="prev" title="VS_TOOL_OVERRIDE" href="VS_TOOL_OVERRIDE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

VS_XAML_TYPE

VS_XAML_TYPE¶

New in version 3.3.

Mark a Extensible Application Markup Language (XAML) source file
as a different type than the default Page.
The most common usage would be to set the default App.xaml file as
ApplicationDefinition.

Previous topic

VS_TOOL_OVERRIDE

Next topic

WRAP_EXCLUDE

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) »

VS_XAML_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>WRAP_EXCLUDE — 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="XCODE_EXPLICIT_FILE_TYPE" href="XCODE_EXPLICIT_FILE_TYPE.html" />
    <link rel="prev" title="VS_XAML_TYPE" href="VS_XAML_TYPE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

WRAP_EXCLUDE

WRAP_EXCLUDE¶

Exclude this source file from any code wrapping techniques.

Some packages can wrap source files into alternate languages to
provide additional functionality.

For example, C++ code can be wrapped into Java or Python, using SWIG.
If WRAP_EXCLUDE is set to True, that indicates that this
source file should not be wrapped.

Previous topic

VS_XAML_TYPE

Next topic

XCODE_EXPLICIT_FILE_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) »

WRAP_EXCLUDE

        © 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>XCODE_EXPLICIT_FILE_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="XCODE_FILE_ATTRIBUTES" href="XCODE_FILE_ATTRIBUTES.html" />
    <link rel="prev" title="WRAP_EXCLUDE" href="WRAP_EXCLUDE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

XCODE_EXPLICIT_FILE_TYPE

XCODE_EXPLICIT_FILE_TYPE¶

New in version 3.1.

Set the Xcode explicitFileType attribute on its reference to a
source file.  CMake computes a default based on file extension but
can be told explicitly with this property.

See also XCODE_LAST_KNOWN_FILE_TYPE.

Previous topic

WRAP_EXCLUDE

Next topic

XCODE_FILE_ATTRIBUTES

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) »

XCODE_EXPLICIT_FILE_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>XCODE_FILE_ATTRIBUTES — 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="XCODE_LAST_KNOWN_FILE_TYPE" href="XCODE_LAST_KNOWN_FILE_TYPE.html" />
    <link rel="prev" title="XCODE_EXPLICIT_FILE_TYPE" href="XCODE_EXPLICIT_FILE_TYPE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

XCODE_FILE_ATTRIBUTES

XCODE_FILE_ATTRIBUTES¶

New in version 3.7.

Add values to the Xcode ATTRIBUTES setting on its reference to a
source file.  Among other things, this can be used to set the role on
a .mig file:

set_source_files_properties(defs.mig
    PROPERTIES
        XCODE_FILE_ATTRIBUTES "Client;Server"
)

Previous topic

XCODE_EXPLICIT_FILE_TYPE

Next topic

XCODE_LAST_KNOWN_FILE_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) »

XCODE_FILE_ATTRIBUTES

        © 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>XCODE_LAST_KNOWN_FILE_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="ADVANCED" href="../prop_cache/ADVANCED.html" />
    <link rel="prev" title="XCODE_FILE_ATTRIBUTES" href="XCODE_FILE_ATTRIBUTES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

XCODE_LAST_KNOWN_FILE_TYPE

XCODE_LAST_KNOWN_FILE_TYPE¶

New in version 3.1.

Set the Xcode lastKnownFileType attribute on its reference to
a source file.  CMake computes a default based on file extension but
can be told explicitly with this property.

See also XCODE_EXPLICIT_FILE_TYPE, which is preferred
over this property if set.

Previous topic

XCODE_FILE_ATTRIBUTES

Next topic

ADVANCED

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) »

XCODE_LAST_KNOWN_FILE_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>ATTACHED_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="ATTACHED_FILES_ON_FAIL" href="ATTACHED_FILES_ON_FAIL.html" />
    <link rel="prev" title="XCTEST" href="../prop_tgt/XCTEST.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ATTACHED_FILES

ATTACHED_FILES¶

Attach a list of files to a dashboard submission.

Set this property to a list of files that will be encoded and
submitted to the dashboard as an addition to the test result.

Previous topic

XCTEST

Next topic

ATTACHED_FILES_ON_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) »

ATTACHED_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>ATTACHED_FILES_ON_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="COST" href="COST.html" />
    <link rel="prev" title="ATTACHED_FILES" href="ATTACHED_FILES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ATTACHED_FILES_ON_FAIL

ATTACHED_FILES_ON_FAIL¶

Attach a list of files to a dashboard submission if the test fails.

Same as ATTACHED_FILES, but these files will only be
included if the test does not pass.

Previous topic

ATTACHED_FILES

Next topic

COST

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) »

ATTACHED_FILES_ON_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>COST — 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="DEPENDS" href="DEPENDS.html" />
    <link rel="prev" title="ATTACHED_FILES_ON_FAIL" href="ATTACHED_FILES_ON_FAIL.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

COST

COST¶

This property describes the cost of a test.  When parallel testing is
enabled, tests in the test set will be run in descending order of cost.
Projects can explicitly define the cost of a test by setting this property
to a floating point value.

When the cost of a test is not defined by the project,
ctest will initially use a default cost of 0.
It computes a weighted average of the cost each time a test is run and
uses that as an improved estimate of the cost for the next run.  The more
a test is re-run in the same build directory, the more representative the
cost should become.

Previous topic

ATTACHED_FILES_ON_FAIL

Next topic

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) »

COST

        © 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>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="DISABLED" href="DISABLED.html" />
    <link rel="prev" title="COST" href="COST.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

DEPENDS

DEPENDS¶

Specifies that this test should only be run after the specified list of tests.

Set this to a list of tests that must finish before this test is run. The
results of those tests are not considered, the dependency relationship is
purely for order of execution (i.e. it is really just a run after
relationship). Consider using test fixtures with setup tests if a dependency
with successful completion is required (see FIXTURES_REQUIRED).

Examples¶

add_test(NAME baseTest1 ...)
add_test(NAME baseTest2 ...)
add_test(NAME dependsTest12 ...)

set_tests_properties(dependsTest12 PROPERTIES DEPENDS "baseTest1;baseTest2")
# dependsTest12 runs after baseTest1 and baseTest2, even if they fail

Table of Contents

DEPENDS

Examples

Previous topic

COST

Next topic

DISABLED

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) »

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>DISABLED — 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="ENVIRONMENT" href="ENVIRONMENT.html" />
    <link rel="prev" title="DEPENDS" href="DEPENDS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

DISABLED

DISABLED¶

New in version 3.9.

If set to True, the test will be skipped and its status will be 'Not Run'. A
DISABLED test will not be counted in the total number of tests and its
completion status will be reported to CDash as Disabled.

A DISABLED test does not participate in test fixture dependency resolution.
If a DISABLED test has fixture requirements defined in its
FIXTURES_REQUIRED property, it will not cause setup or cleanup
tests for those fixtures to be added to the test set.

If a test with the FIXTURES_SETUP property set is DISABLED,
the fixture behavior will be as though that setup test was passing and any test
case requiring that fixture will still run.

Previous topic

DEPENDS

Next topic

ENVIRONMENT

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) »

DISABLED

        © 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>ENVIRONMENT — 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="ENVIRONMENT_MODIFICATION" href="ENVIRONMENT_MODIFICATION.html" />
    <link rel="prev" title="DISABLED" href="DISABLED.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ENVIRONMENT

ENVIRONMENT¶

Specify environment variables that should be defined for running a test.

Set to a semicolon-separated list list
of environment variables and values of the form MYVAR=value.
Those environment variables will be defined while running the test.
The environment changes from this property do not affect other tests.

Previous topic

DISABLED

Next topic

ENVIRONMENT_MODIFICATION

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) »

ENVIRONMENT

        © 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>ENVIRONMENT_MODIFICATION — 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="FAIL_REGULAR_EXPRESSION" href="FAIL_REGULAR_EXPRESSION.html" />
    <link rel="prev" title="ENVIRONMENT" href="ENVIRONMENT.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

ENVIRONMENT_MODIFICATION

ENVIRONMENT_MODIFICATION¶

New in version 3.22.

Specify environment variables that should be modified for running a test. Note
that the operations performed by this property are performed after the
ENVIRONMENT property is already applied.

Set to a semicolon-separated list of
environment variables and values of the form MYVAR=OP:VALUE,
where MYVAR is the case-sensitive name of an environment variable
to be modified.  Entries are considered in the order specified in the
property's value.  The OP may be one of:

reset: Reset to the unmodified value, ignoring all modifications to
MYVAR prior to this entry. Note that this will reset the variable to
the value set by ENVIRONMENT, if it was set, and otherwise
to its state from the rest of the CTest execution.

set: Replaces the current value of MYVAR with VALUE.

unset: Unsets the current value of MYVAR.

string_append: Appends singular VALUE to the current value of
MYVAR.

string_prepend: Prepends singular VALUE to the current value of
MYVAR.

path_list_append: Appends singular VALUE to the current value of
MYVAR using the host platform's path list separator (; on Windows
and : elsewhere).

path_list_prepend: Prepends singular VALUE to the current value of
MYVAR using the host platform's path list separator (; on Windows
and : elsewhere).

cmake_list_append: Appends singular VALUE to the current value of
MYVAR using ; as the separator.

cmake_list_prepend: Prepends singular VALUE to the current value of
MYVAR using ; as the separator.

Unrecognized OP values will result in the test failing before it is
executed. This is so that future operations may be added without changing
valid behavior of existing tests.

The environment changes from this property do not affect other tests.

Previous topic

ENVIRONMENT

Next topic

FAIL_REGULAR_EXPRESSION

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) »

ENVIRONMENT_MODIFICATION

        © 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>FAIL_REGULAR_EXPRESSION — 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="FIXTURES_CLEANUP" href="FIXTURES_CLEANUP.html" />
    <link rel="prev" title="ENVIRONMENT_MODIFICATION" href="ENVIRONMENT_MODIFICATION.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

FAIL_REGULAR_EXPRESSION

FAIL_REGULAR_EXPRESSION¶

If the test output (stdout or stderr) matches this regular expression the test
will fail, regardless of the process exit code. Tests that exceed the timeout
specified by TIMEOUT fail regardless of
FAIL_REGULAR_EXPRESSION. Any non-zero return code or system-level test
failures including segmentation faults, signal abort, or heap errors fail the
test even if the regular expression does not match.

If set, if the output matches one of specified regular expressions, the test
will fail.  Example:

# test would pass, except for FAIL_REGULAR_EXPRESSION
add_test(NAME mytest COMMAND ${CMAKE_COMMAND} -E echo "Failed")

set_property(TEST mytest PROPERTY
  FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
)

FAIL_REGULAR_EXPRESSION expects a list of regular expressions.

See also the PASS_REGULAR_EXPRESSION and
SKIP_REGULAR_EXPRESSION test properties.

Previous topic

ENVIRONMENT_MODIFICATION

Next topic

FIXTURES_CLEANUP

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) »

FAIL_REGULAR_EXPRESSION

        © 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>FIXTURES_CLEANUP — 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="FIXTURES_REQUIRED" href="FIXTURES_REQUIRED.html" />
    <link rel="prev" title="FAIL_REGULAR_EXPRESSION" href="FAIL_REGULAR_EXPRESSION.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

FIXTURES_CLEANUP

FIXTURES_CLEANUP¶

New in version 3.7.

Specifies a list of fixtures for which the test is to be treated as a cleanup
test. These fixture names are distinct from test case names and are not
required to have any similarity to the names of tests associated with them.

Fixture cleanup tests are ordinary tests with all of the usual test
functionality. Setting the FIXTURES_CLEANUP property for a test has two
primary effects:

CTest will ensure the test executes after all other tests which list any of
the fixtures in its FIXTURES_REQUIRED property.

If CTest is asked to run only a subset of tests (e.g. using regular
expressions or the --rerun-failed option) and the cleanup test is not in
the set of tests to run, it will automatically be added if any tests in the
set require any fixture listed in FIXTURES_CLEANUP.

A cleanup test can have multiple fixtures listed in its FIXTURES_CLEANUP
property. It will execute only once for the whole CTest run, not once for each
fixture. A fixture can also have more than one cleanup test defined. If there
are multiple cleanup tests for a fixture, projects can control their order with
the usual DEPENDS test property if necessary.

A cleanup test is allowed to require other fixtures, but not any fixture listed
in its FIXTURES_CLEANUP property. For example:

# Ok: Dependent fixture is different to cleanup
set_tests_properties(cleanupFoo PROPERTIES
  FIXTURES_CLEANUP  Foo
  FIXTURES_REQUIRED Bar
)

# Error: cannot require same fixture as cleanup
set_tests_properties(cleanupFoo PROPERTIES
  FIXTURES_CLEANUP  Foo
  FIXTURES_REQUIRED Foo
)

Cleanup tests will execute even if setup or regular tests for that fixture fail
or are skipped.

See FIXTURES_REQUIRED for a more complete discussion of how to use
test fixtures.

Previous topic

FAIL_REGULAR_EXPRESSION

Next topic

FIXTURES_REQUIRED

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) »

FIXTURES_CLEANUP

        © 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>FIXTURES_REQUIRED — 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="FIXTURES_SETUP" href="FIXTURES_SETUP.html" />
    <link rel="prev" title="FIXTURES_CLEANUP" href="FIXTURES_CLEANUP.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

FIXTURES_REQUIRED

FIXTURES_REQUIRED¶

New in version 3.7.

Specifies a list of fixtures the test requires. Fixture names are case
sensitive and they are not required to have any similarity to test names.

Fixtures are a way to attach setup and cleanup tasks to a set of tests. If a
test requires a given fixture, then all tests marked as setup tasks for that
fixture will be executed first (once for the whole set of tests, not once per
test requiring the fixture). After all tests requiring a particular fixture
have completed, CTest will ensure all tests marked as cleanup tasks for that
fixture are then executed. Tests are marked as setup tasks with the
FIXTURES_SETUP property and as cleanup tasks with the
FIXTURES_CLEANUP property. If any of a fixture's setup tests fail,
all tests listing that fixture in their FIXTURES_REQUIRED property will not
be executed. The cleanup tests for the fixture will always be executed, even if
some setup tests fail.

When CTest is asked to execute only a subset of tests (e.g. by the use of
regular expressions or when run with the --rerun-failed
command line option), it will automatically add any setup or cleanup tests for
fixtures required by any of the tests that are in the execution set. This
behavior can be overridden with the -FS,
-FC and -FA command line options to
ctest(1) if desired.

Since setup and cleanup tasks are also tests, they can have an ordering
specified by the DEPENDS test property just like any other tests.
This can be exploited to implement setup or cleanup using multiple tests for a
single fixture to modularise setup or cleanup logic.

The concept of a fixture is different to that of a resource specified by
RESOURCE_LOCK, but they may be used together. A fixture defines a
set of tests which share setup and cleanup requirements, whereas a resource
lock has the effect of ensuring a particular set of tests do not run in
parallel. Some situations may need both, such as setting up a database,
serializing test access to that database and deleting the database again at the
end. For such cases, tests would populate both FIXTURES_REQUIRED and
RESOURCE_LOCK to combine the two behaviors. Names used for
RESOURCE_LOCK have no relationship with names of fixtures, so note
that a resource lock does not imply a fixture and vice versa.

Consider the following example which represents a database test scenario
similar to that mentioned above:

add_test(NAME testsDone   COMMAND emailResults)
add_test(NAME fooOnly     COMMAND testFoo)
add_test(NAME dbOnly      COMMAND testDb)
add_test(NAME dbWithFoo   COMMAND testDbWithFoo)
add_test(NAME createDB    COMMAND initDB)
add_test(NAME setupUsers  COMMAND userCreation)
add_test(NAME cleanupDB   COMMAND deleteDB)
add_test(NAME cleanupFoo  COMMAND removeFoos)

set_tests_properties(setupUsers PROPERTIES DEPENDS createDB)

set_tests_properties(createDB   PROPERTIES FIXTURES_SETUP    DB)
set_tests_properties(setupUsers PROPERTIES FIXTURES_SETUP    DB)
set_tests_properties(cleanupDB  PROPERTIES FIXTURES_CLEANUP  DB)
set_tests_properties(cleanupFoo PROPERTIES FIXTURES_CLEANUP  Foo)
set_tests_properties(testsDone  PROPERTIES FIXTURES_CLEANUP  "DB;Foo")

set_tests_properties(fooOnly    PROPERTIES FIXTURES_REQUIRED Foo)
set_tests_properties(dbOnly     PROPERTIES FIXTURES_REQUIRED DB)
set_tests_properties(dbWithFoo  PROPERTIES FIXTURES_REQUIRED "DB;Foo")

set_tests_properties(dbOnly dbWithFoo createDB setupUsers cleanupDB
                     PROPERTIES RESOURCE_LOCK DbAccess)

Key points from this example:

Two fixtures are defined: DB and Foo. Tests can require a single
fixture as fooOnly and dbOnly do, or they can depend on multiple
fixtures like dbWithFoo does.

A DEPENDS relationship is set up to ensure setupUsers happens after
createDB, both of which are setup tests for the DB fixture and will
therefore be executed before the dbOnly and dbWithFoo tests
automatically.

No explicit DEPENDS relationships were needed to make the setup tests run
before or the cleanup tests run after the regular tests.

The Foo fixture has no setup tests defined, only a single cleanup test.

testsDone is a cleanup test for both the DB and Foo fixtures.
Therefore, it will only execute once regular tests for both fixtures have
finished (i.e. after fooOnly, dbOnly and dbWithFoo). No
DEPENDS relationship was specified for testsDone, so it is free to
run before, after or concurrently with other cleanup tests for either
fixture.

The setup and cleanup tests never list the fixtures they are for in their own
FIXTURES_REQUIRED property, as that would result in a dependency on
themselves and be considered an error.

Previous topic

FIXTURES_CLEANUP

Next topic

FIXTURES_SETUP

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) »

FIXTURES_REQUIRED

        © 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>FIXTURES_SETUP — 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="GENERATED_RESOURCE_SPEC_FILE" href="GENERATED_RESOURCE_SPEC_FILE.html" />
    <link rel="prev" title="FIXTURES_REQUIRED" href="FIXTURES_REQUIRED.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

FIXTURES_SETUP

FIXTURES_SETUP¶

New in version 3.7.

Specifies a list of fixtures for which the test is to be treated as a setup
test. These fixture names are distinct from test case names and are not
required to have any similarity to the names of tests associated with them.

Fixture setup tests are ordinary tests with all of the usual test
functionality. Setting the FIXTURES_SETUP property for a test has two
primary effects:

CTest will ensure the test executes before any other test which lists the
fixture name(s) in its FIXTURES_REQUIRED property.

If CTest is asked to run only a subset of tests (e.g. using regular
expressions or the --rerun-failed option) and the setup test is not in
the set of tests to run, it will automatically be added if any tests in the
set require any fixture listed in FIXTURES_SETUP.

A setup test can have multiple fixtures listed in its FIXTURES_SETUP
property. It will execute only once for the whole CTest run, not once for each
fixture. A fixture can also have more than one setup test defined. If there are
multiple setup tests for a fixture, projects can control their order with the
usual DEPENDS test property if necessary.

A setup test is allowed to require other fixtures, but not any fixture listed
in its FIXTURES_SETUP property. For example:

# Ok: dependent fixture is different to setup
set_tests_properties(setupFoo PROPERTIES
  FIXTURES_SETUP    Foo
  FIXTURES_REQUIRED Bar
)

# Error: cannot require same fixture as setup
set_tests_properties(setupFoo PROPERTIES
  FIXTURES_SETUP    Foo
  FIXTURES_REQUIRED Foo
)

If any of a fixture's setup tests fail, none of the tests listing that fixture
in its FIXTURES_REQUIRED property will be run. Cleanup tests will,
however, still be executed.

See FIXTURES_REQUIRED for a more complete discussion of how to use
test fixtures.

Previous topic

FIXTURES_REQUIRED

Next topic

GENERATED_RESOURCE_SPEC_FILE

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) »

FIXTURES_SETUP

        © 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>GENERATED_RESOURCE_SPEC_FILE — 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="LABELS" href="LABELS.html" />
    <link rel="prev" title="FIXTURES_SETUP" href="FIXTURES_SETUP.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

GENERATED_RESOURCE_SPEC_FILE

GENERATED_RESOURCE_SPEC_FILE¶

New in version 3.28.

Path to the dynamically-generated resource spec file generated by this test.

Previous topic

FIXTURES_SETUP

Next topic

LABELS

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) »

GENERATED_RESOURCE_SPEC_FILE

        © 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>LABELS — 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="MEASUREMENT" href="MEASUREMENT.html" />
    <link rel="prev" title="GENERATED_RESOURCE_SPEC_FILE" href="GENERATED_RESOURCE_SPEC_FILE.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

LABELS

LABELS¶

Specify a list of text labels associated with a test.  The labels are
reported in both the ctest output summary and in dashboard submissions.
They can also be used to filter the set of tests to be executed (see the
ctest -L and ctest -LE options).

See Additional Labels for adding labels to a test dynamically during
test execution.

Previous topic

GENERATED_RESOURCE_SPEC_FILE

Next topic

MEASUREMENT

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) »

LABELS

        © 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>MEASUREMENT — 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="PASS_REGULAR_EXPRESSION" href="PASS_REGULAR_EXPRESSION.html" />
    <link rel="prev" title="LABELS" href="LABELS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

MEASUREMENT

MEASUREMENT¶

Specify a CDASH measurement and value to be reported for a test.

If set to a name then that name will be reported to CDASH as a named
measurement with a value of 1.  You may also specify a value by
setting MEASUREMENT to measurement=value.

Previous topic

LABELS

Next topic

PASS_REGULAR_EXPRESSION

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) »

MEASUREMENT

        © 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>PASS_REGULAR_EXPRESSION — 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="PROCESSOR_AFFINITY" href="PROCESSOR_AFFINITY.html" />
    <link rel="prev" title="MEASUREMENT" href="MEASUREMENT.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

PASS_REGULAR_EXPRESSION

PASS_REGULAR_EXPRESSION¶

The test output (stdout or stderr) must match this regular expression
for the test to pass. The process exit code is ignored. Tests that exceed
the timeout specified by TIMEOUT still fail regardless of
PASS_REGULAR_EXPRESSION. System-level test failures including
segmentation faults, signal abort, or heap errors may fail the test even
if PASS_REGULAR_EXPRESSION is matched.

Example:

add_test(NAME mytest COMMAND ${CMAKE_COMMAND} -E echo "Passed this test")

set_property(TEST mytest PROPERTY
  PASS_REGULAR_EXPRESSION "pass;Passed"
)

PASS_REGULAR_EXPRESSION expects a list of regular expressions.

To run a test that may have a system-level failure, but still pass if
PASS_REGULAR_EXPRESSION 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)

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

set_property(TEST sigabrt PROPERTY PROPERTY_REGULAR_EXPRESSION "pass;Passed")

#include <signal.h>
#include <stdio.h>

int main(void){
    fprintf(stdout, "Passed\n");
    fflush(stdout);  /* ensure the output buffer is seen */
    raise(SIGABRT);
    return 0;
}

See also the FAIL_REGULAR_EXPRESSION and
SKIP_REGULAR_EXPRESSION test properties.

Previous topic

MEASUREMENT

Next topic

PROCESSOR_AFFINITY

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) »

PASS_REGULAR_EXPRESSION

        © 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>PROCESSORS — 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="REQUIRED_FILES" href="REQUIRED_FILES.html" />
    <link rel="prev" title="PROCESSOR_AFFINITY" href="PROCESSOR_AFFINITY.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

PROCESSORS

PROCESSORS¶

Set to specify how many process slots this test requires.
If not set, the default is 1 processor.

Denotes the number of processors that this test will require.  This is
typically used for MPI tests, and should be used in conjunction with
the ctest_test() PARALLEL_LEVEL option.

This will also be used to display a weighted test timing result in label and
subproject summaries in the command line output of ctest(1). The wall
clock time for the test run will be multiplied by this property to give a
better idea of how much cpu resource CTest allocated for the test.

See also the PROCESSOR_AFFINITY test property.

Previous topic

PROCESSOR_AFFINITY

Next topic

REQUIRED_FILES

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) »

PROCESSORS

        © 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>PROCESSOR_AFFINITY — 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="PROCESSORS" href="PROCESSORS.html" />
    <link rel="prev" title="PASS_REGULAR_EXPRESSION" href="PASS_REGULAR_EXPRESSION.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

PROCESSOR_AFFINITY

PROCESSOR_AFFINITY¶

New in version 3.12.

Set to a true value to ask CTest to launch the test process with CPU affinity
for a fixed set of processors.  If enabled and supported for the current
platform, CTest will choose a set of processors to place in the CPU affinity
mask when launching the test process.  The number of processors in the set is
determined by the PROCESSORS test property or the number of
processors available to CTest, whichever is smaller.  The set of processors
chosen will be disjoint from the processors assigned to other concurrently
running tests that also have the PROCESSOR_AFFINITY property enabled.

Previous topic

PASS_REGULAR_EXPRESSION

Next topic

PROCESSORS

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) »

PROCESSOR_AFFINITY

        © 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>REQUIRED_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="RESOURCE_GROUPS" href="RESOURCE_GROUPS.html" />
    <link rel="prev" title="PROCESSORS" href="PROCESSORS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

REQUIRED_FILES

REQUIRED_FILES¶

List of files required to run the test.  The filenames are relative to the
test WORKING_DIRECTORY unless an absolute path is specified.

If set to a list of files, the test will not be run unless all of the
files exist.

Examples¶

Suppose that test.txt is created by test baseTest and none.txt
does not exist:

add_test(NAME baseTest ...)   # Assumed to create test.txt
add_test(NAME fileTest ...)

# The following ensures that if baseTest is successful, test.txt will
# have been created before fileTest is run
set_tests_properties(fileTest PROPERTIES
  DEPENDS baseTest
  REQUIRED_FILES test.txt
)

add_test(NAME notRunTest ...)

# The following makes notRunTest depend on two files. Nothing creates
# the none.txt file, so notRunTest will fail with status "Not Run".
set_tests_properties(notRunTest PROPERTIES
  REQUIRED_FILES "test.txt;none.txt"
)

The above example demonstrates how REQUIRED_FILES works, but it is not the
most robust way to implement test ordering with failure detection.  For that,
test fixtures are a better alternative (see FIXTURES_REQUIRED).

Table of Contents

REQUIRED_FILES

Examples

Previous topic

PROCESSORS

Next topic

RESOURCE_GROUPS

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) »

REQUIRED_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>RESOURCE_GROUPS — 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="RESOURCE_LOCK" href="RESOURCE_LOCK.html" />
    <link rel="prev" title="REQUIRED_FILES" href="REQUIRED_FILES.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

RESOURCE_GROUPS

RESOURCE_GROUPS¶

New in version 3.16.

Specify resources required by a test, grouped in a way that is meaningful to
the test.  See resource allocation
for more information on how this property integrates into the CTest resource
allocation feature.

The RESOURCE_GROUPS property is a semicolon-separated list of group descriptions. Each entry consists of an optional
number of groups using the description followed by a series of resource
requirements for those groups. These requirements (and the number of groups)
are separated by commas. The resource requirements consist of the name of a
resource type, followed by a colon, followed by an unsigned integer
specifying the number of slots required on one resource of the given type.

The RESOURCE_GROUPS property tells CTest what resources a test expects
to use grouped in a way meaningful to the test.  The test itself must read
the environment variables to
determine which resources have been allocated to each group.  For example,
each group may correspond to a process the test will spawn when executed.

Consider the following example:

add_test(NAME MyTest COMMAND MyExe)
set_property(TEST MyTest PROPERTY RESOURCE_GROUPS
  "2,gpus:2"
  "gpus:4,crypto_chips:2")

In this example, there are two group descriptions (implicitly separated by a
semicolon.) The content of the first description is 2,gpus:2. This
description specifies 2 groups, each of which requires 2 slots from a single
GPU. The content of the second description is gpus:4,crypto_chips:2. This
description does not specify a group count, so a default of 1 is assumed.
This single group requires 4 slots from a single GPU and 2 slots from a
single cryptography chip. In total, 3 resource groups are specified for this
test, each with its own unique requirements.

Note that the number of slots following the resource type specifies slots from
a single instance of the resource. If the resource group can tolerate
receiving slots from different instances of the same resource, it can indicate
this by splitting the specification into multiple requirements of one slot. For
example:

add_test(NAME MyTest COMMAND MyExe)
set_property(TEST MyTest PROPERTY RESOURCE_GROUPS
  "gpus:1,gpus:1,gpus:1,gpus:1")

In this case, the single resource group indicates that it needs four GPU slots,
all of which may come from separate GPUs (though they don't have to; CTest may
still assign slots from the same GPU.)

When CTest sets the environment variables for a test, it assigns a group number
based on the group description, starting at 0 on the left and the number of
groups minus 1 on the right. For example, in the example above, the two
groups in the first description would have IDs of 0 and 1, and the single
group in the second description would have an ID of 2.

Both the RESOURCE_GROUPS and RESOURCE_LOCK properties serve
similar purposes, but they are distinct and orthogonal. Resources specified by
RESOURCE_GROUPS do not affect RESOURCE_LOCK, and vice versa.
Whereas RESOURCE_LOCK is a simpler property that is used for
locking one global resource, RESOURCE_GROUPS is a more advanced property
that allows multiple tests to simultaneously use multiple resources of the
same type, specifying their requirements in a fine-grained manner.

Previous topic

REQUIRED_FILES

Next topic

RESOURCE_LOCK

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) »

RESOURCE_GROUPS

        © 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>RESOURCE_LOCK — 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="RUN_SERIAL" href="RUN_SERIAL.html" />
    <link rel="prev" title="RESOURCE_GROUPS" href="RESOURCE_GROUPS.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

RESOURCE_LOCK

RESOURCE_LOCK¶

Specify a list of resources that are locked by this test.

If multiple tests specify the same resource lock, they are guaranteed
not to run concurrently.

See also FIXTURES_REQUIRED if the resource requires any setup or
cleanup steps.

Both the RESOURCE_GROUPS and RESOURCE_LOCK properties serve
similar purposes, but they are distinct and orthogonal. Resources specified by
RESOURCE_GROUPS do not affect RESOURCE_LOCK, and vice versa.
Whereas RESOURCE_LOCK is a simpler property that is used for locking one
global resource, RESOURCE_GROUPS is a more advanced property
that allows multiple tests to simultaneously use multiple resources of the
same type, specifying their requirements in a fine-grained manner.

Previous topic

RESOURCE_GROUPS

Next topic

RUN_SERIAL

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) »

RESOURCE_LOCK

        © 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>RUN_SERIAL — 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="SKIP_REGULAR_EXPRESSION" href="SKIP_REGULAR_EXPRESSION.html" />
    <link rel="prev" title="RESOURCE_LOCK" href="RESOURCE_LOCK.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

RUN_SERIAL

RUN_SERIAL¶

Do not run this test in parallel with any other test.

Use this option in conjunction with the ctest_test PARALLEL_LEVEL
option to specify that this test should not be run in parallel with
any other tests.

Previous topic

RESOURCE_LOCK

Next topic

SKIP_REGULAR_EXPRESSION

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) »

RUN_SERIAL

        © 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>SKIP_REGULAR_EXPRESSION — 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="SKIP_RETURN_CODE" href="SKIP_RETURN_CODE.html" />
    <link rel="prev" title="RUN_SERIAL" href="RUN_SERIAL.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-properties(7) »

SKIP_REGULAR_EXPRESSION

SKIP_REGULAR_EXPRESSION¶

New in version 3.16.

If the test output (stderr or stdout) matches this regular expression the test
will be marked as skipped, regardless of the process exit code. Tests that
exceed the timeout specified by TIMEOUT still fail regardless of
SKIP_REGULAR_EXPRESSION. System-level test failures including segmentation
faults, signal abort, or heap errors may fail the test even if the regular
expression matches.

Example:

add_test(NAME mytest COMMAND ${CMAKE_COMMAND} -E echo "Skipped this test")

set_property(TEST mytest PROPERTY
  SKIP_REGULAR_EXPRESSION "[^a-z]Skip" "SKIP" "Skipped"
)

SKIP_REGULAR_EXPRESSION expects a list of regular expressions.

To run a test that may have a system-level failure, but still skip if
SKIP_REGULAR_EXPRESSION 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)

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

set_property(TEST sigabrt PROPERTY SKIP_REGULAR_EXPRESSION "SIGABRT;[aA]bort")

#include <signal.h>

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

See also the SKIP_RETURN_CODE,
PASS_REGULAR_EXPRESSION, and FAIL_REGULAR_EXPRESSION
test properties.

Previous topic

RUN_SERIAL

Next topic

SKIP_RETURN_CODE

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_REGULAR_EXPRESSION

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