Завантажує і виконує CMake-код з файлу або модуля.

Сигнатура і опис

include(<file|module> [OPTIONAL] [RESULT_VARIABLE <var>]
                      [NO_POLICY_SCOPE])

Завантажує і виконує CMake-код з вказаного у якості параметра шлаху до файла. Зчитування і записування змінних отримує доступ з області коду, який викликає команду include(). Якщо переданий необов’язковий аргумент OPTIONAL, тоді жодна помилка не генерується якщо файл за вказаним шляхом не існує. Якщо переданий параметр RESULT_VARIABLE тоді змінна <var> буде встановленою у повну назву файлу який був підключений або у значення NOTFOUND якщо ні.

Якщо вказаний модуль замість звичайного файлу, тоді спочатку виконується пошук файлу <modulename>.exe у CMAME_MODULE_PATH, після чого у директорії модулів CMake. Є одне виключення для цієї поведніки: якщо файл, який викликає команду include() сам по собі розміщений у вбудованій директорії модулів CMake, тоді спочатку виконується пошук у вбудованій директорії модуля і тільки після цього CMAKE_MODULE_PATH. Детальніше у документі політики CMP0017.

Деталі у документації команди cmake_policy() для обговорення необов’язкового параметру NO_POLICY_SCOPE.

Оригінал

Оригінал документу розміщений за адресою https://cmake.org/cmake/help/latest/command/include.html