search

FairRootGroup / FairRoot

C++ simulation, reconstruction and analysis framework for particle physics experiments
http://fairroot.gsi.de
Other
57 stars 96 forks source link

Export CMAKEMOD dir #1560

Closed dennisklein closed 2 months ago

dennisklein commented 2 months ago

Shall be backported to v19.0 and v18.8 as well.

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@dennisklein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 46 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between bd68c0fa95fd8ad1b20d0c1a33c084ac0c2aa7e9 and 60baa2dec401c5b2c66f4b585c3d3b60c474bce2.

Walkthrough

The recent changes primarily entail updating copyright details and adding a new CMake variable for specifying the directory of project-specific CMake modules. There are no modifications to publicly exported entities, ensuring compatibility remains intact.

Changes

File Change Summary
cmake/CMakeLists.txt Updated copyright year and added set command for PROJECT_CMAKE_MODULES_DIR
cmake/private/FairRootConfig.cmake.in Added @PROJECT_NAME@_CMAKE_MODULES_DIR declaration
cmake/private/FairRootPackage.cmake Updated copyright year and added PROJECT_CMAKEMOD_DIR to PATH_VARS list

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
ChristianTackeGSI commented 2 months ago

Why this shortened name? Why not FairRoot_CMAKE_MODULES_DIR?

dennisklein commented 2 months ago

Why this shortened name? Why not FairRoot_CMAKE_MODULES_DIR?

Inherited from here I guess. I don't mind the longer one, if you prefer it.

ChristianTackeGSI commented 2 months ago

Why this shortened name? Why not FairRoot_CMAKE_MODULES_DIR?

Inherited from here I guess. I don't mind the longer one, if you prefer it.

Thanks for using the longer name. I think, it's more readable.

Looking at your linked find module

https://github.com/FairRootGroup/FairRoot/blob/fad0a30d19c05742b0fe50cc49dbcd410d326bb7/cmake/modules/FindFairRoot.cmake#L33

I wonder, whether we should replace the FIND_PATH with something like this?


set(FAIRROOT_CMAKEMOD_DIR "${FairRoot_CMAKE_MODULES_DIR}")
dennisklein commented 2 months ago

Why this shortened name? Why not FairRoot_CMAKE_MODULES_DIR?

Inherited from here I guess. I don't mind the longer one, if you prefer it.

Thanks for using the longer name. I think, it's more readable.

Looking at your linked find module

https://github.com/FairRootGroup/FairRoot/blob/fad0a30d19c05742b0fe50cc49dbcd410d326bb7/cmake/modules/FindFairRoot.cmake#L33

I wonder, whether we should replace the FIND_PATH with something like this?

set(FAIRROOT_CMAKEMOD_DIR "${FairRoot_CMAKE_MODULES_DIR}")

Hmm, possibly yes. But only once the new exported variable here is actually released. As the FindFairRoot.cmake file is copied by users, such a refactoring will need to be done conditionally on the found FairRoot version.

ChristianTackeGSI commented 2 months ago

Maybe something like this?

if(FairRoot_CMAKE_MODULES_DIR)
  set(FAIRROOT_CMAKEMOD_DIR "${FairRoot_CMAKE_MODULES_DIR}")
else()
  FIND_PATH(FAIRROOT_CMAKEMOD_DIR
    NAMES modules/FindFairRoot.cmake modules/ROOTMacros.cmake
    PATHS ${FAIRROOTPATH}/share/fairbase/cmake
  )
endif()
dennisklein commented 2 months ago 
if(FairRoot_CMAKE_MODULES_DIR)
  set(FAIRROOT_CMAKEMOD_DIR "${FairRoot_CMAKE_MODULES_DIR}")
else()
  FIND_PATH(FAIRROOT_CMAKEMOD_DIR
    NAMES modules/FindFairRoot.cmake modules/ROOTMacros.cmake
    PATHS ${FAIRROOTPATH}/share/fairbase/cmake
  )
endif()

True, done. I made it a cache variable as that is what find_path() does:

//Path to a file.
FAIRROOT_CMAKEMOD_DIR:PATH=/home/dklein/projects/FairRoot/install/share/fairbase/cmake