Skip to content

Commit

Permalink
WIP: Remove 'Fully' from 'Fully TriBITS-Compliant' (and variations) (#63
Browse files Browse the repository at this point in the history 
)

* Replaced "fully TriBITS-compliant" with "TriBITS-compliant" (all
  capitalizations and with or without '-')

* Replaced "TriBITS-compatible" with "TriBITS-compliant" (all capitalizations
  and with or without '-')

* Renamed `tribits_process_enabled_fully_tribits_compatible_or_upstream_tpl()`
   to `tribits_process_enabled_tribits_compliant_or_upstream_tpl()`

* Renamed `tribits_process_enabled_tribits_compatible_tpl()` to
  `tribits_process_enabled_tribits_compliant_tpl()`

* Updated some documentaiton I noticed while making these replacements
  • Loading branch information
@bartlettroscoe
bartlettroscoe committed Feb 7, 2023
1 parent 6d2d6bf commit 4532a56
Show file tree
Hide file tree
Showing 10 changed files with 88 additions and 87 deletions.
30 changes: 15 additions & 15 deletions test/core/ExamplesUnitTests/TribitsExampleProject2_Tests.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -935,18 +935,18 @@ function(TribitsExampleProject2_External_Package_by_Package
PASS_REGULAR_EXPRESSION_ALL
"Adjust the set of internal and external packages:"
"-- Treating internal package Package1 as EXTERNAL because TPL_ENABLE_Package1=ON"
"-- NOTE: Tpl1 is directly downstream from an fully TriBITS-compatible external package Package1"
"-- NOTE: Tpl1 is directly downstream from an TriBITS-compliant external package Package1"

"Final set of enabled top-level packages: Package2 1"
"Final set of non-enabled top-level packages: Package3 1"
"Final set of enabled top-level external packages/TPLs: Tpl1 Tpl2 Tpl3 Package1 4"
"Final set of non-enabled top-level external packages/TPLs: Tpl4 1"

"Getting information for all enabled fully TriBITS-compatible or upstream external packages/TPLs ..."
"Getting information for all enabled TriBITS-compliant or upstream external packages/TPLs ..."
"Processing enabled external package/TPL: Tpl1 [(]enabled by Package1, disable with -DTPL_ENABLE_Tpl1=OFF[)]"
"-- The external package/TPL Tpl1 will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL Tpl1 will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: Package1 [(]enabled explicitly, disable with -DTPL_ENABLE_Package1=OFF[)]"
"-- Calling find_package[(]Package1[)] for TriBITS-compatible package"
"-- Calling find_package[(]Package1[)] for TriBITS-compliant package"

"Getting information for all enabled external packages/TPLs ..."
"Processing enabled external package/TPL: Tpl2 [(]enabled explicitly, disable with -DTPL_ENABLE_Tpl2=OFF[)]"
Expand Down Expand Up @@ -998,28 +998,28 @@ function(TribitsExampleProject2_External_Package_by_Package
"Adjust the set of internal and external packages:"
"-- Treating internal package Package2 as EXTERNAL because TPL_ENABLE_Package2=ON"
"-- Treating internal package Package1 as EXTERNAL because downstream package Package2 being treated as EXTERNAL"
"-- NOTE: Package1 is directly downstream from an fully TriBITS-compatible external package Package2"
"-- NOTE: Tpl3 is directly downstream from an fully TriBITS-compatible external package Package2"
"-- NOTE: Tpl1 is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: Tpl2 is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: Tpl1 is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: Package1 is directly downstream from an TriBITS-compliant external package Package2"
"-- NOTE: Tpl3 is directly downstream from an TriBITS-compliant external package Package2"
"-- NOTE: Tpl1 is indirectly downstream from an TriBITS-compliant external package"
"-- NOTE: Tpl2 is indirectly downstream from an TriBITS-compliant external package"
"-- NOTE: Tpl1 is indirectly downstream from an TriBITS-compliant external package"

"Final set of enabled top-level packages: Package3 1"
"Final set of non-enabled top-level packages: 0"
"Final set of enabled top-level external packages/TPLs: Tpl1 Tpl2 Tpl3 Tpl4 Package1 Package2 6"
"Final set of non-enabled top-level external packages/TPLs: 0"

"Getting information for all enabled fully TriBITS-compatible or upstream external packages/TPLs ..."
"Getting information for all enabled TriBITS-compliant or upstream external packages/TPLs ..."
"Processing enabled external package/TPL: Tpl1 [(]enabled explicitly, disable with -DTPL_ENABLE_Tpl1=OFF[)]"
"-- The external package/TPL Tpl1 will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL Tpl1 will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: Tpl2 [(]enabled explicitly, disable with -DTPL_ENABLE_Tpl2=OFF[)]"
"-- The external package/TPL Tpl2 will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL Tpl2 will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: Tpl3 [(]enabled explicitly, disable with -DTPL_ENABLE_Tpl3=OFF[)]"
"-- The external package/TPL Tpl3 will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL Tpl3 will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: Package1 [(]enabled explicitly, disable with -DTPL_ENABLE_Package1=OFF[)]"
"-- The external package/TPL Package1 will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL Package1 will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: Package2 [(]enabled explicitly, disable with -DTPL_ENABLE_Package2=OFF[)]"
"-- Calling find_package[(]Package2[)] for TriBITS-compatible package"
"-- Calling find_package[(]Package2[)] for TriBITS-compliant package"
"Getting information for all enabled external packages/TPLs ..."

"Processing enabled external package/TPL: Tpl4 [(]enabled explicitly, disable with -DTPL_ENABLE_Tpl4=OFF[)]"
Expand Down
46 changes: 23 additions & 23 deletions test/core/ExamplesUnitTests/TribitsExampleProject_Tests.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3297,8 +3297,8 @@ tribits_add_advanced_test( TribitsExampleProject_External_SimpleCxx
PASS_REGULAR_EXPRESSION_ALL
"Adjust the set of internal and external packages:"
"-- Treating internal package SimpleCxx as EXTERNAL because TPL_ENABLE_SimpleCxx=ON"
"-- NOTE: HeaderOnlyTpl is directly downstream from an fully TriBITS-compatible external package SimpleCxx"
"-- NOTE: SimpleTpl is directly downstream from an fully TriBITS-compatible external package SimpleCxx"
"-- NOTE: HeaderOnlyTpl is directly downstream from an TriBITS-compliant external package SimpleCxx"
"-- NOTE: SimpleTpl is directly downstream from an TriBITS-compliant external package SimpleCxx"

"Final set of enabled top-level packages: MixedLang WithSubpackages WrapExternal 3"
"Final set of enabled packages: MixedLang WithSubpackagesA WithSubpackagesB WithSubpackagesC WithSubpackages WrapExternal 6"
Expand All @@ -3309,13 +3309,13 @@ tribits_add_advanced_test( TribitsExampleProject_External_SimpleCxx
"Final set of non-enabled top-level external packages/TPLs: MPI 1"
"Final set of non-enabled external packages/TPLs: MPI 1"

"Getting information for all enabled fully TriBITS-compatible or upstream external packages/TPLs ..."
"Getting information for all enabled TriBITS-compliant or upstream external packages/TPLs ..."
"Processing enabled external package/TPL: HeaderOnlyTpl [(]enabled by SimpleCxx, disable with -DTPL_ENABLE_HeaderOnlyTpl=OFF[)]"
"-- The external package/TPL HeaderOnlyTpl will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL HeaderOnlyTpl will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: SimpleTpl [(]enabled explicitly, disable with -DTPL_ENABLE_SimpleTpl=OFF[)]"
"-- The external package/TPL SimpleTpl will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL SimpleTpl will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: SimpleCxx [(]enabled explicitly, disable with -DTPL_ENABLE_SimpleCxx=OFF[)]"
"-- Calling find_package[(]SimpleCxx[)] for TriBITS-compatible package"
"-- Calling find_package[(]SimpleCxx[)] for TriBITS-compliant package"

"Getting information for all enabled external packages/TPLs ..."

Expand Down Expand Up @@ -3489,18 +3489,18 @@ tribits_add_advanced_test( TribitsExampleProject_External_Package_by_Package
"-- Treating internal package WithSubpackagesA as EXTERNAL because downstream package WithSubpackages being treated as EXTERNAL"
"-- Treating internal package WithSubpackagesB as EXTERNAL because downstream package WithSubpackages being treated as EXTERNAL"
"-- Treating internal package WithSubpackagesC as EXTERNAL because downstream package WithSubpackages being treated as EXTERNAL"
"-- NOTE: WithSubpackagesA is directly downstream from an fully TriBITS-compatible external package WithSubpackages"
"-- NOTE: WithSubpackagesB is directly downstream from an fully TriBITS-compatible external package WithSubpackages"
"-- NOTE: WithSubpackagesC is directly downstream from an fully TriBITS-compatible external package WithSubpackages"
"-- NOTE: WithSubpackagesA is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: WithSubpackagesB is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: WithSubpackagesA is directly downstream from an TriBITS-compliant external package WithSubpackages"
"-- NOTE: WithSubpackagesB is directly downstream from an TriBITS-compliant external package WithSubpackages"
"-- NOTE: WithSubpackagesC is directly downstream from an TriBITS-compliant external package WithSubpackages"
"-- NOTE: WithSubpackagesA is indirectly downstream from an TriBITS-compliant external package"
"-- NOTE: WithSubpackagesB is indirectly downstream from an TriBITS-compliant external package"
"-- Treating internal package SimpleCxx as EXTERNAL because downstream package WithSubpackagesB being treated as EXTERNAL"
"-- NOTE: SimpleCxx is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: WithSubpackagesA is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: SimpleCxx is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: SimpleCxx is indirectly downstream from an TriBITS-compliant external package"
"-- NOTE: WithSubpackagesA is indirectly downstream from an TriBITS-compliant external package"
"-- NOTE: SimpleCxx is indirectly downstream from an TriBITS-compliant external package"
"-- Treating internal package MixedLang as EXTERNAL because TPL_ENABLE_MixedLang=ON"
"-- NOTE: HeaderOnlyTpl is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: SimpleTpl is indirectly downstream from an fully TriBITS-compatible external package"
"-- NOTE: HeaderOnlyTpl is indirectly downstream from an TriBITS-compliant external package"
"-- NOTE: SimpleTpl is indirectly downstream from an TriBITS-compliant external package"

"Final set of enabled top-level packages: WrapExternal 1"
"Final set of enabled packages: WrapExternal 1"
Expand All @@ -3511,17 +3511,17 @@ tribits_add_advanced_test( TribitsExampleProject_External_Package_by_Package
"Final set of non-enabled top-level external packages/TPLs: MPI 1"
"Final set of non-enabled external packages/TPLs: MPI 1"

"Getting information for all enabled fully TriBITS-compatible or upstream external packages/TPLs ..."
"Getting information for all enabled TriBITS-compliant or upstream external packages/TPLs ..."
"Processing enabled external package/TPL: HeaderOnlyTpl [(]enabled by SimpleCxx, disable with -DTPL_ENABLE_HeaderOnlyTpl=OFF[)]"
"-- The external package/TPL HeaderOnlyTpl will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL HeaderOnlyTpl will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: SimpleTpl [(]enabled explicitly, disable with -DTPL_ENABLE_SimpleTpl=OFF[)]"
"-- The external package/TPL SimpleTpl will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL SimpleTpl will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: SimpleCxx [(]enabled explicitly, disable with -DTPL_ENABLE_SimpleCxx=OFF[)]"
"-- The external package/TPL SimpleCxx will be read in by a downstream fully TriBITS-compliant external package"
"-- The external package/TPL SimpleCxx will be read in by a downstream TriBITS-compliant external package"
"Processing enabled external package/TPL: MixedLang [(]enabled explicitly, disable with -DTPL_ENABLE_MixedLang=OFF[)]"
"-- Calling find_package[(]MixedLang[)] for TriBITS-compatible package"
"-- Calling find_package[(]MixedLang[)] for TriBITS-compliant package"
"Processing enabled external package/TPL: WithSubpackages [(]enabled explicitly, disable with -DTPL_ENABLE_WithSubpackages=OFF[)]"
"-- Calling find_package[(]WithSubpackages[)] for TriBITS-compatible package"
"-- Calling find_package[(]WithSubpackages[)] for TriBITS-compliant package"

"Getting information for all enabled external packages/TPLs ..."

Expand Down Expand Up @@ -3555,7 +3555,7 @@ tribits_add_advanced_test( TribitsExampleProject_External_Package_by_Package
)
# NOTE: The above test is a strong check that packages can be installed
# individually in stages on top of each other and that we are correctly
# writing wrapper <Package>Config.cmake files for fully TriBITS-compatible
# writing wrapper <Package>Config.cmake files for TriBITS-compliant
# external packages (in this case for WithSubpackagesAConfig.cmake to
# include).

Expand Down
10 changes: 5 additions & 5 deletions tribits/core/package_arch/TribitsAdjustPackageEnables.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ endmacro()
# NOTE: Above, we are sweeping over *all* of the not-disabled packages listed
# in ${PROJECT_NAME}_DEFINED_INTERNAL_PACKAGES, including those package that
# might have <Package>_PACKAGE_BUILD_STATUS=EXTERNAL. That makes sense
# because these are TriBITS (or TriBITS compatible) packages so we should
# because these are TriBITS (or TriBITS-compliant) packages so we should
# assume that all of their downstream packages, whether internal or external,
# should be enabled as well. If we find this is not the desirable behavior,
# then we can change this later.
Expand Down Expand Up @@ -1321,7 +1321,7 @@ endmacro()


# Macro that sets all of the direct upstream dependent packages as being
# processed by a downstream fully TriBITS compliant external package.
# processed by a downstream TriBITS-compliant external package.
macro(tribits_set_package_and_deps_as_processed_by_downstream_tribits_external_package
packageName
)
Expand All @@ -1335,7 +1335,7 @@ macro(tribits_set_package_and_deps_as_processed_by_downstream_tribits_external_p
tribits_get_package_enable_status(${packageName} packageEnable "")

if (${packageName}_PACKAGE_BUILD_STATUS STREQUAL "EXTERNAL"
AND (${packageName}_IS_FULLY_TRIBITS_COMPLIANT
AND (${packageName}_IS_TRIBITS_COMPLIANT
OR ${packageName}_PROCESSED_BY_DOWNSTREAM_TRIBITS_EXTERNAL_PACKAGE)
)

Expand All @@ -1351,8 +1351,8 @@ macro(tribits_set_package_and_deps_as_processed_by_downstream_tribits_external_p
tribits_get_package_enable_status(${depPkg} depPkgEnable "")
if (depPkgEnable)
message("-- "
"NOTE: ${depPkg} is ${directOrIndirectStr} downstream from an fully"
" TriBITS-compatible external package${downstreamPkgStr}")
"NOTE: ${depPkg} is ${directOrIndirectStr} downstream from an"
" TriBITS-compliant external package${downstreamPkgStr}")
endif()
set(${depPkg}_PROCESSED_BY_DOWNSTREAM_TRIBITS_EXTERNAL_PACKAGE TRUE)
endforeach()
Expand Down
2 changes: 1 addition & 1 deletion tribits/core/package_arch/TribitsExternalPackageWriteConfigFile.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ function(tribits_extpkgwit_append_package_config_file_header_str
set(configFileStr "${${configFileStrVarInOut}}")
string(APPEND configFileStr
"# TriBITS-compliant Package config file for external package/TPL '${tplName}'\n"
"# based on non fully TriBITS-compliant external package '${externalPkg}' that uses\n"
"# based on non TriBITS-compliant external package '${externalPkg}' that uses\n"
"# modern IMPORTED targets\n"
"#\n"
"# Generated by CMake, do not edit!\n"
Expand Down
20 changes: 10 additions & 10 deletions tribits/core/package_arch/TribitsProcessEnabledTpls.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ macro(tribits_process_enabled_tpls)
EXTERNAL ON NONEMPTY ${PROJECT_NAME}_enabledExternalTopLevelPackages)

message("")
message("Getting information for all enabled fully TriBITS-compatible"
message("Getting information for all enabled TriBITS-compliant"
" or upstream external packages/TPLs ...")
message("")

foreach(TPL_NAME IN LISTS ${PROJECT_NAME}_enabledExternalTopLevelPackages)
if (${TPL_NAME}_IS_FULLY_TRIBITS_COMPLIANT
if (${TPL_NAME}_IS_TRIBITS_COMPLIANT
OR ${TPL_NAME}_PROCESSED_BY_DOWNSTREAM_TRIBITS_EXTERNAL_PACKAGE
)
tribits_process_enabled_fully_tribits_compatible_or_upstream_tpl(${TPL_NAME})
tribits_process_enabled_tribits_compliant_or_upstream_tpl(${TPL_NAME})
endif()
endforeach()

Expand All @@ -76,7 +76,7 @@ macro(tribits_process_enabled_tpls)
message("")

foreach(TPL_NAME IN LISTS ${PROJECT_NAME}_enabledExternalTopLevelPackages)
if ((NOT ${TPL_NAME}_IS_FULLY_TRIBITS_COMPLIANT)
if ((NOT ${TPL_NAME}_IS_TRIBITS_COMPLIANT)
AND (NOT ${TPL_NAME}_PROCESSED_BY_DOWNSTREAM_TRIBITS_EXTERNAL_PACKAGE)
)
tribits_process_enabled_standard_tpl(${TPL_NAME})
Expand All @@ -89,18 +89,18 @@ macro(tribits_process_enabled_tpls)
endmacro()


macro(tribits_process_enabled_fully_tribits_compatible_or_upstream_tpl TPL_NAME)
macro(tribits_process_enabled_tribits_compliant_or_upstream_tpl TPL_NAME)

tribits_get_enabled_tpl_processing_string(${TPL_NAME} tplProcessingString)
message("${tplProcessingString}")

if (NOT ${PROJECT_NAME}_TRACE_DEPENDENCY_HANDLING_ONLY)
if (NOT ${TPL_NAME}_PROCESSED_BY_DOWNSTREAM_TRIBITS_EXTERNAL_PACKAGE)
tribits_process_enabled_tribits_compatible_tpl(${TPL_NAME})
tribits_process_enabled_tribits_compliant_tpl(${TPL_NAME})
else()
message("-- "
"The external package/TPL ${TPL_NAME} will be read in by a downstream"
" fully TriBITS-compliant external package")
" TriBITS-compliant external package")
endif()
endif()

Expand Down Expand Up @@ -147,12 +147,12 @@ function(tribits_get_enabled_tpl_processing_string TPL_NAME tplProcessingStrin
endfunction()


# Process an enabled TPL defined using a fully TriBITS-compatible external
# Process an enabled TPL defined using a TriBITS-compliant external
# packages <tplName>Config.cmake file
#
macro(tribits_process_enabled_tribits_compatible_tpl TPL_NAME)
macro(tribits_process_enabled_tribits_compliant_tpl TPL_NAME)
message("-- "
"Calling find_package(${TPL_NAME}) for TriBITS-compatible package")
"Calling find_package(${TPL_NAME}) for TriBITS-compliant package")
find_package(${TPL_NAME} CONFIG REQUIRED)
endmacro()

Expand Down
4 changes: 2 additions & 2 deletions tribits/core/package_arch/TribitsProcessPackagesAndDirsLists.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ macro(tribits_process_packages_and_dirs_lists REPOSITORY_NAME REPOSITORY_DIR)
set(${TRIBITS_PACKAGE}_PARENT_REPOSITORY ${REPOSITORY_NAME})
tribits_insert_standard_package_options(${TRIBITS_PACKAGE} ${PACKAGE_TESTGROUP})
set(${TRIBITS_PACKAGE}_PACKAGE_BUILD_STATUS INTERNAL)
set(${TRIBITS_PACKAGE}_IS_FULLY_TRIBITS_COMPLIANT TRUE)
set(${TRIBITS_PACKAGE}_IS_TRIBITS_COMPLIANT TRUE)
else()
if (${PROJECT_NAME}_VERBOSE_CONFIGURE)
message(
Expand All @@ -594,7 +594,7 @@ macro(tribits_process_packages_and_dirs_lists REPOSITORY_NAME REPOSITORY_DIR)
print_var(${TRIBITS_PACKAGE}_PARENT_PACKAGE)
print_var(${TRIBITS_PACKAGE}_PARENT_REPOSITORY)
print_var(${TRIBITS_PACKAGE}_PACKAGE_BUILD_STATUS)
print_var(${TRIBITS_PACKAGE}_IS_FULLY_TRIBITS_COMPLIANT)
print_var(${TRIBITS_PACKAGE}_IS_TRIBITS_COMPLIANT)
endif()

if (TRIBITS_PROCESS_PACKAGES_AND_DIRS_LISTS_VERBOSE)
Expand Down
Loading

0 comments on commit 4532a56

Please sign in to comment.