Skip to content
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.

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

add cmake doc #607

Merged
merged 11 commits into from
Jun 4, 2024
Merged

add cmake doc #607

merged 11 commits into from
Jun 4, 2024

Conversation

hegner
Copy link
Collaborator

@hegner hegner commented May 24, 2024

BEGINRELEASENOTES

  • Add documentation for CMake macros
    ENDRELEASENOTES

@hegner hegner requested a review from tmadlener May 24, 2024 09:49
@hegner
Copy link
Collaborator Author

hegner commented May 24, 2024

This addresses #604

Copy link
Collaborator

@tmadlener tmadlener left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should also mention the additional arguments that are available from PODIO_GENERATE_DATAMODEL. At least the UPSTREAM_EDM (with a pointer to EDM4eic potentially) and the LANG arguments.

The DEPENDS one is at least touched upon at the datamodel syntax introduction.

I also think this has to be added to doc/index.rst at an appropriate place.

doc/cmake.md Outdated Show resolved Hide resolved
doc/cmake.md Outdated Show resolved Hide resolved
doc/cmake.md Outdated Show resolved Hide resolved
hegner and others added 2 commits May 24, 2024 15:23
Co-authored-by: Thomas Madlener <thomas.madlener@desy.de>
Co-authored-by: Thomas Madlener <thomas.madlener@desy.de>
@tmadlener tmadlener linked an issue May 24, 2024 that may be closed by this pull request
@m-fila
Copy link
Contributor

m-fila commented May 24, 2024

What do you think about adding a link to macro definitions in podioMacros.cmake for reference? In other projects sometimes they put their user-facing cmake macros in some obscure places and I wish they simply put a link in docs to save me from greping everything 😅

doc/cmake.md Outdated Show resolved Hide resolved
doc/cmake.md Outdated Show resolved Hide resolved
doc/cmake.md Outdated Show resolved Hide resolved
hegner and others added 3 commits May 27, 2024 09:34
Co-authored-by: Thomas Madlener <thomas.madlener@desy.de>
Co-authored-by: Thomas Madlener <thomas.madlener@desy.de>
Co-authored-by: Thomas Madlener <thomas.madlener@desy.de>
doc/cmake.md Outdated Show resolved Hide resolved
doc/cmake.md Outdated Show resolved Hide resolved
Co-authored-by: Andre Sailer <andre.philippe.sailer@cern.ch>
@tmadlener
Copy link
Collaborator

Should we merge this now and add the advanced usage in another PR?

@hegner hegner merged commit 7db028f into AIDASoft:master Jun 4, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the cmake functionality
4 participants