Skip to content

Commit 738e250

Browse files
jathujathu
committed
rename config -> option
1 parent 50c54c1 commit 738e250

File tree

3 files changed

+29
-29
lines changed

3 files changed

+29
-29
lines changed

‎tools/cmake/common/preset.cmake‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44
# This source code is licensed under the BSD-style license found in the
55
# LICENSE file in the root directory of this source tree.
66

7-
# Enforce config names to always start with EXECUTORCH_, else raise an error.
8-
function(enforce_executorch_config_name NAME)
7+
# Enforce option names to always start with EXECUTORCH.
8+
function(enforce_executorch_option_name NAME)
99
if(NOT "${NAME}" MATCHES "^EXECUTORCH_")
10-
message(FATAL_ERROR "Config name '${NAME}' must start with EXECUTORCH_")
10+
message(FATAL_ERROR "Option name '${NAME}' must start with EXECUTORCH_")
1111
endif()
1212
endfunction()
1313

14-
# Define an overridable config.
15-
# 1) If the config is already defined in the process, then store that in cache
16-
# 2) If the config is NOT set, then store the default value in cache
17-
macro(define_overridable_config NAME DESCRIPTION VALUE_TYPE DEFAULT_VALUE)
18-
enforce_executorch_config_name(${NAME})
14+
# Define an overridable option.
15+
# 1) If the option is already defined in the process, then store that in cache
16+
# 2) If the option is NOT set, then store the default value in cache
17+
macro(define_overridable_option NAME DESCRIPTION VALUE_TYPE DEFAULT_VALUE)
18+
enforce_executorch_option_name(${NAME})
1919

2020
if(NOT "${VALUE_TYPE}" STREQUAL "STRING" AND NOT "${VALUE_TYPE}" STREQUAL "BOOL")
21-
message(FATAL_ERROR "Invalid config (${NAME}) value type '${VALUE_TYPE}', must be either STRING or BOOL")
21+
message(FATAL_ERROR "Invalid option (${NAME}) value type '${VALUE_TYPE}', must be either STRING or BOOL")
2222
endif()
2323

2424
if(DEFINED ${NAME})

‎tools/cmake/common/preset_test.py‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -65,28 +65,28 @@ def test_set_option(self):
6565
self.assert_cmake_cache("SECRET_MESSAGE", "move fast", "STRING")
6666
self.assert_cmake_cache("PI", "3.14", "STRING")
6767

68-
def test_define_overridable_config_invalid_name(self):
68+
def test_define_overridable_option_invalid_name(self):
6969
_cmake_lists_txt = """
7070
cmake_minimum_required(VERSION 3.24)
7171
project(test_preset)
7272
include(${PROJECT_SOURCE_DIR}/preset.cmake)
73-
define_overridable_config(IAM_AN_INVALID_NAME "test example" STRING "default value")
73+
define_overridable_option(IAM_AN_INVALID_NAME "test example" STRING "default value")
7474
"""
7575
self.create_workspace({"CMakeLists.txt": _cmake_lists_txt})
7676
self.run_cmake(
77-
error_contains="Config name 'IAM_AN_INVALID_NAME' must start with EXECUTORCH_"
77+
error_contains="Option name 'IAM_AN_INVALID_NAME' must start with EXECUTORCH_"
7878
)
7979

80-
def test_define_overridable_config_default(self):
80+
def test_define_overridable_option_default(self):
8181
_cmake_lists_txt = """
8282
cmake_minimum_required(VERSION 3.24)
8383
project(test_preset)
8484
include(${PROJECT_SOURCE_DIR}/preset.cmake)
8585
add_subdirectory(example)
8686
"""
8787
_example_cmake_lists_txt = """
88-
define_overridable_config(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
89-
define_overridable_config(EXECUTORCH_TEST_OPTION "test option" BOOL ON)
88+
define_overridable_option(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
89+
define_overridable_option(EXECUTORCH_TEST_OPTION "test option" BOOL ON)
9090
"""
9191
self.create_workspace(
9292
{
@@ -100,27 +100,27 @@ def test_define_overridable_config_default(self):
100100
self.assert_cmake_cache("EXECUTORCH_TEST_MESSAGE", "default value", "STRING")
101101
self.assert_cmake_cache("EXECUTORCH_TEST_OPTION", "ON", "BOOL")
102102

103-
def test_define_overridable_config_invalid_type(self):
103+
def test_define_overridable_option_invalid_type(self):
104104
_cmake_lists_txt = """
105105
cmake_minimum_required(VERSION 3.24)
106106
project(test_preset)
107107
include(${PROJECT_SOURCE_DIR}/preset.cmake)
108-
define_overridable_config(EXECUTORCH_TEST_MESSAGE "test example" NUMBER "default value")
108+
define_overridable_option(EXECUTORCH_TEST_MESSAGE "test example" NUMBER "default value")
109109
"""
110110
self.create_workspace({"CMakeLists.txt": _cmake_lists_txt})
111111
self.run_cmake(
112-
error_contains="Invalid config (EXECUTORCH_TEST_MESSAGE) value type 'NUMBER'"
112+
error_contains="Invalid option (EXECUTORCH_TEST_MESSAGE) value type 'NUMBER'"
113113
)
114114

115-
def test_define_overridable_config_cli_override(self):
115+
def test_define_overridable_option_cli_override(self):
116116
_cmake_lists_txt = """
117117
cmake_minimum_required(VERSION 3.24)
118118
project(test_preset)
119119
include(${PROJECT_SOURCE_DIR}/preset.cmake)
120120
add_subdirectory(example)
121121
"""
122122
_example_cmake_lists_txt = """
123-
define_overridable_config(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
123+
define_overridable_option(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
124124
"""
125125
self.create_workspace(
126126
{
@@ -133,7 +133,7 @@ def test_define_overridable_config_cli_override(self):
133133
self.run_cmake(cmake_args=["-DEXECUTORCH_TEST_MESSAGE='cli value'"])
134134
self.assert_cmake_cache("EXECUTORCH_TEST_MESSAGE", "cli value", "STRING")
135135

136-
def test_define_overridable_config_set_override_before(self):
136+
def test_define_overridable_option_set_override_before(self):
137137
_cmake_lists_txt = """
138138
cmake_minimum_required(VERSION 3.24)
139139
project(test_preset)
@@ -142,7 +142,7 @@ def test_define_overridable_config_set_override_before(self):
142142
add_subdirectory(example)
143143
"""
144144
_example_cmake_lists_txt = """
145-
define_overridable_config(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
145+
define_overridable_option(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
146146
"""
147147
self.create_workspace(
148148
{
@@ -155,7 +155,7 @@ def test_define_overridable_config_set_override_before(self):
155155
self.run_cmake()
156156
self.assert_cmake_cache("EXECUTORCH_TEST_MESSAGE", "set value", "STRING")
157157

158-
def testdefine_overridable_config_set_override_after(self):
158+
def test_define_overridable_option_set_override_after(self):
159159
_cmake_lists_txt = """
160160
cmake_minimum_required(VERSION 3.24)
161161
project(test_preset)
@@ -164,7 +164,7 @@ def testdefine_overridable_config_set_override_after(self):
164164
set(EXECUTORCH_TEST_MESSAGE "set value")
165165
"""
166166
_example_cmake_lists_txt = """
167-
define_overridable_config(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
167+
define_overridable_option(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
168168
"""
169169
self.create_workspace(
170170
{
@@ -178,7 +178,7 @@ def testdefine_overridable_config_set_override_after(self):
178178
# Setting the value after should not affect the cache.
179179
self.assert_cmake_cache("EXECUTORCH_TEST_MESSAGE", "default value", "STRING")
180180

181-
def test_define_overridable_config_set_override_after_with_cache(self):
181+
def test_define_overridable_option_set_override_after_with_cache(self):
182182
_cmake_lists_txt = """
183183
cmake_minimum_required(VERSION 3.24)
184184
project(test_preset)
@@ -187,7 +187,7 @@ def test_define_overridable_config_set_override_after_with_cache(self):
187187
set(EXECUTORCH_TEST_MESSAGE "set value" CACHE STRING "")
188188
"""
189189
_example_cmake_lists_txt = """
190-
define_overridable_config(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
190+
define_overridable_option(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
191191
"""
192192
self.create_workspace(
193193
{
@@ -201,7 +201,7 @@ def test_define_overridable_config_set_override_after_with_cache(self):
201201
# Setting the value after should not affect the cache.
202202
self.assert_cmake_cache("EXECUTORCH_TEST_MESSAGE", "default value", "STRING")
203203

204-
def test_define_overridable_config_cli_override_with_set_override(self):
204+
def test_define_overridable_option_cli_override_with_set_override(self):
205205
_cmake_lists_txt = """
206206
cmake_minimum_required(VERSION 3.24)
207207
project(test_preset)
@@ -210,7 +210,7 @@ def test_define_overridable_config_cli_override_with_set_override(self):
210210
add_subdirectory(example)
211211
"""
212212
_example_cmake_lists_txt = """
213-
define_overridable_config(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
213+
define_overridable_option(EXECUTORCH_TEST_MESSAGE "test message" STRING "default value")
214214
"""
215215
self.create_workspace(
216216
{

‎tools/cmake/preset/default.cmake‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ endif()
1414

1515
# MARK: - Definitions
1616

17-
define_overridable_config(EXECUTORCH_ENABLE_LOGGING "Build with ET_LOG_ENABLED" BOOL ${_is_build_type_debug})
17+
define_overridable_option(EXECUTORCH_ENABLE_LOGGING "Build with ET_LOG_ENABLED" BOOL ${_is_build_type_debug})

0 commit comments

Comments
 (0)