aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn Ericson <John.Ericson@Obsidian.Systems>2023-04-17 11:58:47 -0400
committerJohn Ericson <John.Ericson@Obsidian.Systems>2023-08-02 15:46:38 -0400
commit3b592c880ae76707cc832e5f227e261be29661bf (patch)
tree8ffcf145ccc3a9cceaaca004e64f0fa8915a3a9e /doc
parent3723363697b3908a2f58dce3e706783b1c783414 (diff)
Add infra for experimental store implemenations
This is analogous to that for experimental settings and flags that we have also added as of late.
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/generate-manpage.nix21
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/manual/generate-manpage.nix b/doc/manual/generate-manpage.nix
index fb34898f3..65eec42d0 100644
--- a/doc/manual/generate-manpage.nix
+++ b/doc/manual/generate-manpage.nix
@@ -137,12 +137,29 @@ let
storeDocs =
let
- showStore = name: { settings, doc }:
- ''
+ showStore = name: { settings, doc, experimentalFeature }:
+ let
+ experimentalFeatureNote = optionalString (experimentalFeature != null) ''
+ > **Warning**
+ > This store is part of an
+ > [experimental feature](@docroot@/contributing/experimental-features.md).
+
+ To use this store, you need to make sure the corresponding experimental feature,
+ [`${experimentalFeature}`](@docroot@/contributing/experimental-features.md#xp-feature-${experimentalFeature}),
+ is enabled.
+ For example, include the following in [`nix.conf`](#):
+
+ ```
+ extra-experimental-features = ${experimentalFeature}
+ ```
+ '';
+ in ''
## ${name}
${doc}
+ ${experimentalFeatureNote}
+
**Settings**:
${showSettings { useAnchors = false; } settings}