diff options
author | John Ericson <John.Ericson@Obsidian.Systems> | 2023-04-04 22:57:11 -0400 |
---|---|---|
committer | John Ericson <John.Ericson@Obsidian.Systems> | 2023-04-04 22:57:11 -0400 |
commit | 53d0836347ea262884658036f97bf19ecbdc5c26 (patch) | |
tree | 1e44ef6c424772ee311c34b4dcd772ac7a3ad96c /src/libutil/experimental-features.hh | |
parent | 3f98353f196bfd1da3641751f4f7826f42581893 (diff) |
Assemble experimental feature docs outside of Nix itself
Instead of constructing a markdown list in C++ (which involved all sorts
of nasty string literals), export some JSON and assemble it with the
manual build system.
Besides following the precedent set with other dumped data, this is a
better separate of content and presentation; if we decide for example we
want to display this information in a different way, or in a different
section of the manual, it will become much easier to do so.
Diffstat (limited to 'src/libutil/experimental-features.hh')
-rw-r--r-- | src/libutil/experimental-features.hh | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/src/libutil/experimental-features.hh b/src/libutil/experimental-features.hh index 3c479dbd9..8ef66263a 100644 --- a/src/libutil/experimental-features.hh +++ b/src/libutil/experimental-features.hh @@ -51,11 +51,9 @@ std::string_view showExperimentalFeature(const ExperimentalFeature); /** * Compute the documentation of all experimental features. * - * This a markdown bulleted list where each item is first (a) the - * experimental feature flag name in backticks, and then (b) the - * description of the experimental feature. + * See `doc/manual` for how this information is used. */ -std::string getExperimentalFeaturesList(); +nlohmann::json documentExperimentalFeatures(); /** * Shorthand for `str << showExperimentalFeature(feature)`. |