wroclaw-git-backups/nix
1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-06-30 03:23:16 +02:00
Code Activity

Assemble experimental feature docs outside of Nix itself

Browse source 
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.
This commit is contained in:
John Ericson 2023-04-04 22:57:11 -04:00
parent 3f98353f19
commit 53d0836347
8 changed files with 55 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/libutil/experimental-features.hh
View file

@ -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)`.