Skip to content

Default values for options BUILD_EXAMPLES and BUILD_DOCS #283

@mfep

Description

@mfep

The following describes a discrepancy in the CMake scripts of the OpenCL-CLHPP project:

  • The test suite is configured to build only if it is explicitly enabled via BUILD_TESTING and if the current project is the root CMake project (or if the project specific OPENCL_CLHPP_BUILD_TESTING option is set).
  • This above is beneficial when the project is consumed by an other project, e.g. via FetchContent, because the test targets are not added. It is unlikely that the parent project is interested in running the tests of the dependent project, but still possible via the aforementioned cache variable.
  • The same logic is not applied to the BUILD_EXAMPLES and BUILD_DOCS options, even though they are also likely to be unneeded by the parent project.
  • An additional downside is that the current setup poses additional dependency requirements on the parent project (both the docs and the examples have a few, albeit the docs will not fail the configuration if Doxygen is not found).
  • It should be considered to add the same logic to BUILD_EXAMPLES and BUILD_DOCS as seen with the BUILD_TESTING option.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions