Skip to content

Commit

Permalink
update documentation for rootcling dictionaries
Browse files Browse the repository at this point in the history
  • Loading branch information
hegner committed Jul 21, 2023
1 parent 7a706b1 commit 61cb984
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/datamodel_syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,6 @@ The podio `PODIO_GENERATE_DATAMODEL` cmake macro has gained an additional parame

### Potential pitfalls
- The cmake macros do not handle linking against an upstream datamodel automatically. It is the users responsibility to explicitly link against the upstream datamodel.
- When generating two datamodels side-by-side and into the same output directory and using the `ROOT` backend, the generated `selection.xml` file might be overwritten if both datamodels are generated into the same output directory.
- When generating two datamodels side-by-side and into the same output directory and using the `ROOT` backend, the generated `LinkDef.h` file might be overwritten if both datamodels are generated into the same output directory.

Limiting this functionality to one upstream datamodel is a conscious choice to limit the potential for abuse of this feature.
2 changes: 1 addition & 1 deletion doc/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ They are broadly split along the classes that are generated for each datatype or
| `[Mutable]Object.{h,cc}.jinja2` | The user facing interfaces for each datatype (living in the user layer) | `[<package>/][Mutable]<datatype-name>.h`, `src/[Mutable]<datatype-name>.cc` |
| `Collection.{h,cc}.jinja2` | The user facing collection interface (living in the user layer) | `[<package>/]<datatype-name>Collection.h`, `src/<datatype-name>Collection.cc` |
| `CollectionData.{h,cc}.jinja2` | The classes managing the collection storage (not user facing!) | `[<package>/]<datatype-name>CollectionData.h`, `src/<datatype-name>CollectionData.cc` |
| `selection.xml.jinja2` | The `selection.xml` file that is necessary for generating a root dictionary for the generated datamodel | `src/selection.xml` |
| `DictLinkDef.h.jinja2` | The `LinkDef.h` file that is necessary for generating a root dictionary for the generated datamodel | `[<package>/]selection.xml` |
| `SIOBlock.{h,cc}.jinja2` | The SIO blocks that are necessary for the SIO backend | `[<package>/]<datatype-name>SIOBlock.h`, `src/<datatype-name>SIOBlock.cc` |

The presence of a `[<package>]` subdirectory for the header files is controlled by the `includeSubfolder` option in the yaml definition file.
Expand Down

0 comments on commit 61cb984

Please sign in to comment.