Document extensions

Add documentation on how to use the newly added extensions mechanisms to implement CoRIM extensions. Signed-off-by: Sergei Trofimov <[email protected]>
veraison · Nov 14, 2023 · 9f5f2a2 · 9f5f2a2
1 parent 64e8c5f
commit 9f5f2a2
Show file tree

Hide file tree

Showing 2 changed files with 405 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,3 +19,16 @@ Before requesting a PR (and routinely during the dev/test cycle), you are encour
 make presubmit
 ```
 and check its output to make sure your code coverage figures are in line with the set target and that there are no newly introduced lint problems.
+
+## Extending CoRIM/CoMID
+
+The CoRIM specification provides a mechanism for adding extensions to the base
+CoRIM schema. The `corim` and `comid` structs which can be extended, embed an
+`Extensions` object  that allows registering a wrapper structure defining
+extension fields. For field types that can be extended, i.e. `type choice`,
+extensions can be implemented by calling an appropriate registration function
+and giving it a new type or a value (for enums).
+
+Please see [extensions documentation](extensions/README.md) for details.
+
+