diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/generate-manpage.nix | 21 |
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} |