New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow packages to use project() #582

Open

masterleinad opened this issue May 19, 2023 · 4 comments

Labels

component: core type: enhancement

Contributor

masterleinad commented May 19, 2023 •

edited

Loading

trilinos/Trilinos#11779 explores using Kokkos as a native CMake project within Trilinos' TriBITS build system. In the process, I noticed that tribits_package_postprocess doesn't work properly if the package uses project(), see https://github.com/trilinos/Trilinos/pull/11779/files#r1196855222, since

TriBITS/tribits/core/package_arch/TribitsPackageMacros.cmake

Line 870 in b669da7

if (${PACKAGE_NAME}_SOURCE_DIR STREQUAL ${PROJECT_NAME}_SOURCE_DIR)

would report that the code is executed at the top level instead of at the package level and then set ${PACKAGE_NAME}_TRIBITS_PACKAGE_POSTPROCESS in the same scope instead of in the parent scope.
Using $(CMAKE_PROJECT_NAME}_SOURCE_DIR) instead of $(PROJECT_NAME}_SOURCE_DIR) fixes this for me.
Note that there might be more cases where it would be more appropriate to check for CMAKE_PROJECT_NAME instead of PROJECT_NAME but this appears sufficient for my case.

The text was updated successfully, but these errors were encountered:

masterleinad mentioned this issue

Kokkos: Avoid using TriBITS in Kokkos trilinos/Trilinos#11779

Closed

Member

bartlettroscoe commented May 19, 2023

I will take care of this when I extend the TriBITS example/test case TribitsExampleProject2/packages/packages1/ to use a raw CMake build system to be TriBITS-compliant for an internal build with calling no TriBITS code.

bartlettroscoe added component: core type: enhancement labels

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Add failing test for using raw CMake for Package1 in TriBITS pro…

d9e5f50

…ject (TriBITSPub#582)

Now we can update TriBITS and the raw Package1 build system for it to work as
a TriBITS package but without calling any TriBITS macros or functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Rename function and improve documentation (TriBITSPub#582)

This makes the documentation ad code a little more clear.

As part of this, I renamed the function
`tribits_write_package_client_export_files_install_targets()` to `
tribits_write_package_client_export_files_export_and_install_targets()`.  That
makes it a little more clear what these functions are doing.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Make TriBITS package with raw CMake work (TriBITSPub#582)

41f794f

NOTE: This does not pass all of the existing tests yet but the new tests pass.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Make TriBITS package TribitsExampleProject/Package1 work with 100% ra…

644540a

…w CMake (TriBITSPub#582)

This raw CMake build mode for Package1 uses no TriBITS macros, functions, or
other functionality at all.

The only change to TriBITS-proper were:

* Skip check for not calling tribits_package_postprocess() if the
  `<Package>::all_libs` target is already defined.

* Build up the list of package libraries target for the `<Project>_libs`
  target from `<Package>::all_libs` instead of `<Package>_libs`.

This seems to pass all of the TriBITS tests.

bartlettroscoe mentioned this issue

Allow 100% raw CMake to be used in a TriBITS-compliant package (#582) #591

Merged

7 tasks

bartlettroscoe added a commit that referenced this issue


          Finish renaming function tribits_write_package_client_export_files_in…

8a43292

…stall_targets() (#582)

Don't know how this was allowed to merge given that the build of the docs was
broken by the renaming of
`tribits_write_package_client_export_files_install_targets()` to
`tribits_write_package_client_export_files_export_and_install_targets()`.

But this fixes that.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Finish renaming function tribits_write_package_client_export_files_in…

3e0faa0

…stall_targets() (TriBITSPub#582)

Don't know how this was allowed to merge given that the build of the docs was
broken by the renaming of
`tribits_write_package_client_export_files_install_targets()` to
`tribits_write_package_client_export_files_export_and_install_targets()`.

But this fixes that.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Finish renaming function tribits_write_package_client_export_files_in…

f77cf6f

…stall_targets() (TriBITSPub#582)

Don't know how this was allowed to merge given that the build of the docs was
broken by the renaming of
`tribits_write_package_client_export_files_install_targets()` to
`tribits_write_package_client_export_files_export_and_install_targets()`.

But this fixes that.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Add failing test for using raw CMake for Package1 in TriBITS pro…

ce9f7bd

…ject (TriBITSPub#582)

Now we can update TriBITS and the raw Package1 build system for it to work as
a TriBITS package but without calling any TriBITS macros or functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Rename function and improve documentation (TriBITSPub#582)

0f186f3

This makes the documentation ad code a little more clear.

As part of this, I renamed the function
`tribits_write_package_client_export_files_install_targets()` to `
tribits_write_package_client_export_files_export_and_install_targets()`.  That
makes it a little more clear what these functions are doing.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Make TriBITS package with raw CMake work (TriBITSPub#582)

21f679b

NOTE: This does not pass all of the existing tests yet but the new tests pass.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Make TriBITS package TribitsExampleProject/Package1 work with 100% ra…

a19d5c4

…w CMake (TriBITSPub#582)

This raw CMake build mode for Package1 uses no TriBITS macros, functions, or
other functionality at all.

The only change to TriBITS-proper were:

* Skip check for not calling tribits_package_postprocess() if the
  `<Package>::all_libs` target is already defined.

* Build up the list of package libraries target for the `<Project>_libs`
  target from `<Package>::all_libs` instead of `<Package>_libs`.

This seems to pass all of the TriBITS tests.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Add failing test for using raw CMake for Package1 in TriBITS pro…

cede956

…ject (TriBITSPub#582)

Now we can update TriBITS and the raw Package1 build system for it to work as
a TriBITS package but without calling any TriBITS macros or functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Rename function and improve documentation (TriBITSPub#582)

20eb79c

This makes the documentation ad code a little more clear.

As part of this, I renamed the function
`tribits_write_package_client_export_files_install_targets()` to `
tribits_write_package_client_export_files_export_and_install_targets()`.  That
makes it a little more clear what these functions are doing.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Make TriBITS package with raw CMake work (TriBITSPub#582)

241d032

NOTE: This does not pass all of the existing tests yet but the new tests pass.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Make TriBITS package TribitsExampleProject/Package1 work with 100% ra…

64c239d

…w CMake (TriBITSPub#582)

This raw CMake build mode for Package1 uses no TriBITS macros, functions, or
other functionality at all.

The only change to TriBITS-proper were:

* Skip check for not calling tribits_package_postprocess() if the
  `<Package>::all_libs` target is already defined.

* Build up the list of package libraries target for the `<Project>_libs`
  target from `<Package>::all_libs` instead of `<Package>_libs`.

This seems to pass all of the TriBITS tests.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Add failing test for using raw CMake for Package1 in TriBITS pro…

80a9b1a

…ject (TriBITSPub#582)

Now we can update TriBITS and the raw Package1 build system for it to work as
a TriBITS package but without calling any TriBITS macros or functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Rename function and improve documentation (TriBITSPub#582)

3ce4dcb

This makes the documentation ad code a little more clear.

As part of this, I renamed the function
`tribits_write_package_client_export_files_install_targets()` to `
tribits_write_package_client_export_files_export_and_install_targets()`.  That
makes it a little more clear what these functions are doing.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Make TriBITS package with raw CMake work (TriBITSPub#582)

7930a20

Allow TriBITS package TribitsExampleProject/Package1 to use 100% raw CMake and
update TriBITS to allow that.

This raw CMake build mode for Package1 uses no TriBITS macros, functions, or
other functionality at all.

The only changes to TriBITS-proper needed to allow this were:

* Skip check for not calling tribits_package_postprocess() if the
  `<Package>::all_libs` target is already defined.

* Build up the list of package libraries target for the `<Project>_libs`
  target from `<Package>::all_libs` instead of `<Package>_libs` (since the
  latter does not exist for a raw CMake package).

This seems to pass all of the TriBITS tests.

NOTE: This commit does **not** yet contain the changes to TriBITS to allow
calling project() in the package's CMakeLists.txt files and still use TriBITS
macros in the package's CMakeLists.txt files.  Those changes will come later
as we add an example that calls some TriBITS functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Add failing test for using raw CMake for Package1 in TriBITS pro…

…ject (TriBITSPub#582)

Now we can update TriBITS and the raw Package1 build system for it to work as
a TriBITS package but without calling any TriBITS macros or functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Rename function and improve documentation (TriBITSPub#582)

5a4eadf

This makes the documentation ad code a little more clear.

As part of this, I renamed the function
`tribits_write_package_client_export_files_install_targets()` to `
tribits_write_package_client_export_files_export_and_install_targets()`.  That
makes it a little more clear what these functions are doing.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Make TriBITS package with raw CMake work (TriBITSPub#582)

8b2a2b2

Allow TriBITS package TribitsExampleProject/Package1 to use 100% raw CMake and
update TriBITS to allow that.

This raw CMake build mode for Package1 uses no TriBITS macros, functions, or
other functionality at all.

The only changes to TriBITS-proper needed to allow this were:

* Skip check for not calling tribits_package_postprocess() if the
  `<Package>::all_libs` target is already defined.

* Build up the list of package libraries target for the `<Project>_libs`
  target from `<Package>::all_libs` instead of `<Package>_libs` (since the
  latter does not exist for a raw CMake package).

This seems to pass all of the TriBITS tests.

NOTE: This commit does **not** yet contain the changes to TriBITS to allow
calling project() in the package's CMakeLists.txt files and still use TriBITS
macros in the package's CMakeLists.txt files.  Those changes will come later
as we add an example that calls some TriBITS functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Add failing test for using raw CMake for Package1 in TriBITS pro…

953efe3

…ject (TriBITSPub#582)

Now we can update TriBITS and the raw Package1 build system for it to work as
a TriBITS package but without calling any TriBITS macros or functions.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Rename function and improve documentation (TriBITSPub#582)

6b2b69f

This makes the documentation ad code a little more clear.

As part of this, I renamed the function
`tribits_write_package_client_export_files_install_targets()` to `
tribits_write_package_client_export_files_export_and_install_targets()`.  That
makes it a little more clear what these functions are doing.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Add conditional for generating <Package>Config.cmake for build dir (T…

32f8247

…riBITSPub#582)

Makes it more clear what is needed for an internal package and an external
package.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          WIP: Add HowTos for TriBITS-compliant raw CMake package (TriBITSPub#582)

f17669e

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Factor longer parts out of base CMakeLists.raw.cmake to streamline (T…

ed04232

…riBITSPub#582)

This will allow me to exclude parts that I don't want to show in the
developers guide.

NOTE: The only reas the test file TribitsExampleProject2_Tests.cmake is
updated is because I took 'a' out of 'in a raw'.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          SQUASH AGAINST: WIP: Add HowTos for TriBITS-compliant raw CMake packa…

32df700

…ge (TriBITSPub#582)

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          SQUASH AGAINST: WIP: Add HowTos for TriBITS-compliant raw CMake packa…

7f7a11a

…ge (TriBITSPub#582)

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Factor longer parts out of base CMakeLists.raw.cmake to streamline (T…

56059fa

…riBITSPub#582)

This will allow me to exclude parts that I don't want to show in the
developers guide.

NOTE: The only reas the test file TribitsExampleProject2_Tests.cmake is
updated is because I took 'a' out of 'in a raw'.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Add NAME and COMMAND to add_test() command in build ref doc (TriBITSP…

ef450ea

…ub#582)

This change was made several years ago but we forgot to update this
documentation.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          SQUASH AGAINST: Factor longer parts out of base CMakeLists.raw.cmake …

617df45

…to streamline (TriBITSPub#582)

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Add HowTos for TriBITS-compliant raw CMake packages (TriBITSPub#582)

eddbfc1

Several things were done here:

* Added new section "How to implement a TriBITS-compliant internal package
  using raw CMake"

* Added new section "How to implement a TriBITS-compliant external package
  using raw CMake"

* Added subsection on example project TribitsExampleProject2 under the "Example
  TriBITS Projects" section.

* Added generation of reduced versions of the package1/CMakeLists.raw.cmake
  file for different cases.  (But will only trigger a re-make if the generated
  files change.)

* Added make dependencies on generated *.cmake files

* generate-guide.sh: Added time to 'make' command and discard STDOUT for 'cd
-' command (makes output look better)

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Fix spelling of package1ConfigRegex (TriBITSPub#582)

bad293d

Caught by @KyleFromKitware

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Remove unneeded quotes around args (TriBITSPub#582)

ca2399a

Caught by @KyleFromKitware

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Remove duplication in tribits_advanced_set_cache_var_and_default() (T…

637fa77

…riBITSPub#582)

Now just calls tribits_set_cache_var_and_default() then mark_as_advanced().

Suggested by @KyleFromKitware

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          DEBUG WIP: Show failing find_package() lib64 and print statements (Tr…

de83368

…iBITSPub#582)

This commit exposes the bug described in:

  https://gitlab.kitware.com/cmake/cmake/-/issues/25157

and provides the suggested print statements by Brad King.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Do edits to new howto sections in users guide (TriBITSPub#368, TriBIT…

b8a1955

…SPub#582)

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Factor longer parts out of base CMakeLists.raw.cmake to streamline (T…

8f66678

…riBITSPub#582)

This will allow me to exclude parts that I don't want to show in the
developers guide.

NOTE: The only reas the test file TribitsExampleProject2_Tests.cmake is
updated is because I took 'a' out of 'in a raw'.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Add NAME and COMMAND to add_test() command in build ref doc (TriBITSP…

762db6e

…ub#582)

This change was made several years ago but we forgot to update this
documentation.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Add HowTos for TriBITS-compliant raw CMake packages (TriBITSPub#582)

967b32e

Several things were done here:

* Added new section "How to implement a TriBITS-compliant internal package
  using raw CMake"

* Added new section "How to implement a TriBITS-compliant external package
  using raw CMake"

* Added subsection on example project TribitsExampleProject2 under the "Example
  TriBITS Projects" section.

* Added generation of reduced versions of the package1/CMakeLists.raw.cmake
  file for different cases.  (But will only trigger a re-make if the generated
  files change.)

* Added make dependencies on generated *.cmake files

* generate-guide.sh: Added time to 'make' command and discard STDOUT for 'cd
-' command (makes output look better)

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Fix spelling of package1ConfigRegex (TriBITSPub#582)

5eae2ca

Caught by @KyleFromKitware

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Remove unneeded quotes around args (TriBITSPub#582)

e507636

Caught by @KyleFromKitware

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Remove duplication in tribits_advanced_set_cache_var_and_default() (T…

4d848d8

…riBITSPub#582)

Now just calls tribits_set_cache_var_and_default() then mark_as_advanced().

Suggested by @KyleFromKitware

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Do edits to new howto sections in users guide (TriBITSPub#368, TriBIT…

c941426

…SPub#582)

bartlettroscoe added a commit that referenced this issue


          Merge pull request #591 from TriBITSPub/582-raw-cmake-as-tribits-package

685c8d5

Allow 100% raw CMake to be used in a TriBITS-compliant package (#582)

Member

bartlettroscoe commented Sep 22, 2023 •

edited

Loading

@masterleinad, would you be willing to review the documentation and examples on how to use 100% raw CMake to create a TriBITS-compliant internal and external package:

Allow 100% raw CMake to be used in a TriBITS-compliant package (#582) #591

?

Specifically, can you please review the documentation and examples at:

Allow 100% raw CMake to be used in a TriBITS-compliant package (#582) #591 (comment)

?

bartlettroscoe added a commit to bartlettroscoe/Trilinos that referenced this issue


          Merge branch 'tribits_github_snapshot' into tribits-582-raw-cmake-tri…

cb8e964

…bits

This brings in the following TriBITS PRs:

* TriBITSPub/TriBITS#591: Allow 100% raw CMake to be used in a
  TriBITS-compliant package (TriBITSPub/TriBITS#582)

* TriBITSPub/TriBITS#588: gitdist: Pass in '-c color.status=always' when
  --dist-no-color is not added

* TriBITSPub/TriBITS#590: Fix: gitdist: dist-repo-status: Display tag or SHA1
  instead of 'HEAD'

* TriBITSPub/TriBITS#587: gitdist: dist-repo-status: Display tag or SHA1
  instead of 'HEAD'

* TriBITSPub/TriBITS#586: More cleanup of packaging support
  (trilinos#11976)

This goes back to TriBITS commits from June 2023.

Contributor Author

masterleinad commented Sep 28, 2023

@masterleinad, would you be willing to review the documentation and examples on how to use 100% raw CMake to create a TriBITS-compliant internal and external package [...]

See #591 (reference) for some quick feedback.

bartlettroscoe added a commit to bartlettroscoe/TriBITS that referenced this issue


          Improve Package1 raw configure message (TriBITSPub#582)

ca31001

This improves the message as suggested by @masterleinad in the review of PR
configured "within a TriBITS project" but is not really being configured "with
TriBITS".  (Package1 is being configured with 100% raw CMake, it just happens
to be configured under a TriBITS project.)

Member

bartlettroscoe commented Jan 25, 2024

When using raw CMake inside of this package, this is a resolved issue as of the merge of PR:

Allow 100% raw CMake to be used in a TriBITS-compliant package (#582) #591

However, if using TriBITS functions inside of the package, then some more work would need to be done (to differentiate the TriBITS project name and base source and binary directories from the most recent call to project()).

So, this should address the Kokkos use case.

bartlettroscoe added this to TriBITS Refactor

bartlettroscoe moved this to In Review in TriBITS Refactor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment