mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-12-31 19:00:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add variable CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY

Browse Source 
Add CMake variable `CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY` to enable
option `DEPENDS_EXPLICIT_ONLY` on all uses of `add_custom_command`.

Fixes: #17097
This commit is contained in:
Abdelmaged Khalifa
2023-02-17 15:11:01 +02:00
parent 51c7917072
commit ea2a05f402
8 changed files with 71 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Auxiliary/vim/syntax/cmake.vim
View File

@@ -459,6 +459,7 @@ syn keyword cmakeVariable contained
\ BUILD_SHARED_LIBS
\ CACHE
\ CMAKE_ABSOLUTE_DESTINATION_FILES
\ CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY
\ CMAKE_AIX_EXPORT_ALL_SYMBOLS
\ CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS
\ CMAKE_ANDROID_API
@@ -2095,6 +2096,7 @@ syn keyword cmakeKWadd_custom_command contained
\ COMMENT
\ CROSSCOMPILING_EMULATOR
\ DEPENDS
\ DEPENDS_EXPLICIT_ONLY
\ DEPFILE
\ GENERATED
\ IMPLICIT_DEPENDS

3
Help/command/add_custom_command.rst
View File

@@ -370,6 +370,9 @@ The options are:
the custom command in case this custom command requires files implicitly
created by those targets.
This option can be enabled on all custom commands by setting
:variable:`CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY` to ``ON``.
Only the :ref:`Ninja Generators` actually use this information to remove
unnecessary implicit dependencies.

1
Help/manual/cmake-variables.7.rst
View File

@@ -166,6 +166,7 @@ Variables that Change Behavior
/variable/BUILD_SHARED_LIBS
/variable/CMAKE_ABSOLUTE_DESTINATION_FILES
/variable/CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY
/variable/CMAKE_APPBUNDLE_PATH
/variable/CMAKE_AUTOMOC_RELAXED_MODE
/variable/CMAKE_BACKWARDS_COMPATIBILITY

4
Help/release/dev/ninja-custom-command-depends.rst
View File

@@ -5,3 +5,7 @@ ninja-custom-command-depends
``DEPENDS_EXPLICIT_ONLY`` option to tell the :ref:`Ninja Generators`
not to add any dependencies implied by the target to which it is
attached.
* The :variable:`CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY` variable can
be set to enable ``DEPENDS_EXPLICIT_ONLY`` in all uses of
:command:`add_custom_command` command.

11
Help/variable/CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY.rst Normal file
View File

@@ -0,0 +1,11 @@
CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY
----------------------------------------------
.. versionadded:: 3.27
Whether to enable DEPENDS_EXPLICIT_ONLY option by default in
:command:`add_custom_command`.
This variable affects the default behavior of the :command:`add_custom_command`
command. Setting this variable to ``ON`` is equivalent to using the ``DEPENDS_EXPLICIT_ONLY``
option in all uses of that command.

3
Source/cmAddCustomCommandCommand.cxx
View File

@@ -49,7 +49,8 @@ bool cmAddCustomCommandCommand(std::vector<std::string> const& args,
bool append = false;
bool uses_terminal = false;
bool command_expand_lists = false;
bool depends_explicit_only = false;
bool depends_explicit_only =
mf.IsOn("CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY");
std::string implicit_depends_lang;
cmImplicitDependsList implicit_depends;

30
Tests/RunCMake/Ninja/CustomCommandExplicitDepends.cmake
View File

@@ -2,17 +2,35 @@ cmake_minimum_required(VERSION 3.26)
project(CustomCommandExplicitDepends C)
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/command.h"
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/command-option.h"
COMMAND "${CMAKE_COMMAND}" -E touch
"${CMAKE_CURRENT_BINARY_DIR}/command.h"
COMMENT "Creating command.h"
"${CMAKE_CURRENT_BINARY_DIR}/command-option.h"
COMMENT "Creating command-option.h"
DEPENDS_EXPLICIT_ONLY
)
add_library(dep STATIC dep.c)
set(CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY ON)
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/command-variable-on.h"
COMMAND "${CMAKE_COMMAND}" -E touch
"${CMAKE_CURRENT_BINARY_DIR}/command-variable-on.h"
COMMENT "Creating command-variable-on.h"
)
add_library(top STATIC
set(CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY OFF)
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/command-variable-off.h"
COMMAND "${CMAKE_COMMAND}" -E touch
"${CMAKE_CURRENT_BINARY_DIR}/command-variable-off.h"
COMMENT "Creating command-variable-off.h"
)
add_library(dep SHARED dep.c)
add_library(top SHARED
top.c
"${CMAKE_CURRENT_BINARY_DIR}/command.h"
"${CMAKE_CURRENT_BINARY_DIR}/command-option.h"
"${CMAKE_CURRENT_BINARY_DIR}/command-variable-on.h"
"${CMAKE_CURRENT_BINARY_DIR}/command-variable-off.h"
)
target_link_libraries(top PRIVATE dep)

28
Tests/RunCMake/Ninja/RunCMakeTest.cmake
View File

@@ -193,11 +193,31 @@ run_LooseObjectDepends()
function (run_CustomCommandExplictDepends)
set(RunCMake_TEST_BINARY_DIR ${RunCMake_BINARY_DIR}/CustomCommandExplicitDepends-build)
run_cmake(CustomCommandExplicitDepends)
run_ninja("${RunCMake_TEST_BINARY_DIR}" "command.h")
if (EXISTS "${RunCMake_TEST_BINARY_DIR}/${CMAKE_STATIC_LIBRARY_PREFIX}dep${CMAKE_STATIC_LIBRARY_SUFFIX}")
set(DEP_LIB "${RunCMake_TEST_BINARY_DIR}/${CMAKE_SHARED_LIBRARY_PREFIX}dep${CMAKE_SHARED_LIBRARY_SUFFIX}")
run_ninja("${RunCMake_TEST_BINARY_DIR}" "command-option.h")
if (EXISTS "${DEP_LIB}")
message(FATAL_ERROR
"The `dep` library was created when requesting an custom command to be "
"generated; this should no longer be necessary when passing DEPENDS_EXPLICIT_ONLY keyword.")
"The `dep` library was created when requesting a custom command to be "
"generated; this should no longer be necessary when passing "
"DEPENDS_EXPLICIT_ONLY option.")
endif ()
run_ninja("${RunCMake_TEST_BINARY_DIR}" "command-variable-on.h")
if (EXISTS "${DEP_LIB}")
message(FATAL_ERROR
"The `dep` library was created when requesting a custom command to be "
"generated; this should no longer be necessary when setting "
"CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY variable to ON.")
endif ()
run_ninja("${RunCMake_TEST_BINARY_DIR}" "command-variable-off.h")
if (NOT EXISTS "${DEP_LIB}")
message(FATAL_ERROR
"The `dep` library was not created when requesting a custom command to be "
"generated; this should be necessary when setting "
"CMAKE_ADD_CUSTOM_COMMAND_DEPENDS_EXPLICIT_ONLY variable to OFF.")
endif ()
endfunction ()
run_CustomCommandExplictDepends()