From 61cb984fc451a89d5d71cb1f4121c9c5d63ba167 Mon Sep 17 00:00:00 2001 From: Benedikt Hegner Date: Fri, 21 Jul 2023 15:21:26 +0200 Subject: [PATCH] update documentation for rootcling dictionaries --- doc/datamodel_syntax.md | 2 +- doc/templates.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/datamodel_syntax.md b/doc/datamodel_syntax.md index e665860e6..51a746461 100644 --- a/doc/datamodel_syntax.md +++ b/doc/datamodel_syntax.md @@ -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. diff --git a/doc/templates.md b/doc/templates.md index 8fc6d8c27..48e010d97 100644 --- a/doc/templates.md +++ b/doc/templates.md @@ -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) | `[/][Mutable].h`, `src/[Mutable].cc` | | `Collection.{h,cc}.jinja2` | The user facing collection interface (living in the user layer) | `[/]Collection.h`, `src/Collection.cc` | | `CollectionData.{h,cc}.jinja2` | The classes managing the collection storage (not user facing!) | `[/]CollectionData.h`, `src/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 | `[/]selection.xml` | | `SIOBlock.{h,cc}.jinja2` | The SIO blocks that are necessary for the SIO backend | `[/]SIOBlock.h`, `src/SIOBlock.cc` | The presence of a `[]` subdirectory for the header files is controlled by the `includeSubfolder` option in the yaml definition file.