diff options
author | Ryan Mulligan <ryan@ryantm.com> | 2021-06-06 13:11:11 -0700 |
---|---|---|
committer | Ryan Mulligan <ryan@ryantm.com> | 2021-06-11 06:06:42 -0700 |
commit | 606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58 (patch) | |
tree | 2d0ecf6492cd50e0a46aa797baa026c2723ad18e /doc | |
parent | 8abb6b4488e75203a9b20fbe286e53ee2582c026 (diff) | |
download | nixpkgs-606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58.tar nixpkgs-606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58.tar.gz nixpkgs-606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58.tar.bz2 nixpkgs-606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58.tar.lz nixpkgs-606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58.tar.xz nixpkgs-606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58.tar.zst nixpkgs-606bf6dc17b6cdc5217a27d9bc703bc0f43f8c58.zip |
doc/functions/generators: convert to CommonMark
Diffstat (limited to 'doc')
-rw-r--r-- | doc/functions.xml | 2 | ||||
-rw-r--r-- | doc/functions/generators.section.md | 56 | ||||
-rw-r--r-- | doc/functions/generators.xml | 74 |
3 files changed, 57 insertions, 75 deletions
diff --git a/doc/functions.xml b/doc/functions.xml index dd91d705aa9..8ef530d307c 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -7,7 +7,7 @@ The nixpkgs repository has several utility functions to manipulate Nix expressions. </para> <xi:include href="functions/library.xml" /> - <xi:include href="functions/generators.xml" /> + <xi:include href="functions/generators.section.xml" /> <xi:include href="functions/debug.section.xml" /> <xi:include href="functions/prefer-remote-fetch.section.xml" /> <xi:include href="functions/nix-gitignore.section.xml" /> diff --git a/doc/functions/generators.section.md b/doc/functions/generators.section.md new file mode 100644 index 00000000000..bb8426d8087 --- /dev/null +++ b/doc/functions/generators.section.md @@ -0,0 +1,56 @@ +# Generators {#sec-generators} +Generators are functions that create file formats from nix data structures, e. g. for configuration files. There are generators available for: `INI`, `JSON` and `YAML` + +All generators follow a similar call interface: `generatorName configFunctions data`, where `configFunctions` is an attrset of user-defined functions that format nested parts of the content. They each have common defaults, so often they do not need to be set manually. An example is `mkSectionName ? (name: libStr.escape [ "[" "]" ] name)` from the `INI` generator. It receives the name of a section and sanitizes it. The default `mkSectionName` escapes `[` and `]` with a backslash. + +Generators can be fine-tuned to produce exactly the file format required by your application/service. One example is an INI-file format which uses `: ` as separator, the strings `"yes"`/`"no"` as boolean values and requires all string values to be quoted: + +```nix +with lib; +let + customToINI = generators.toINI { + # specifies how to format a key/value pair + mkKeyValue = generators.mkKeyValueDefault { + # specifies the generated string for a subset of nix values + mkValueString = v: + if v == true then ''"yes"'' + else if v == false then ''"no"'' + else if isString v then ''"${v}"'' + # and delegats all other values to the default generator + else generators.mkValueStringDefault {} v; + } ":"; + }; + +# the INI file can now be given as plain old nix values +in customToINI { + main = { + pushinfo = true; + autopush = false; + host = "localhost"; + port = 42; + }; + mergetool = { + merge = "diff3"; + }; +} +``` + +This will produce the following INI file as nix string: + +```INI +[main] +autopush:"no" +host:"localhost" +port:42 +pushinfo:"yes" +str\:ange:"very::strange" + +[mergetool] +merge:"diff3" +``` + +::: note +Nix store paths can be converted to strings by enclosing a derivation attribute like so: `"${drv}"`. +::: + +Detailed documentation for each generator can be found in `lib/generators.nix`. diff --git a/doc/functions/generators.xml b/doc/functions/generators.xml deleted file mode 100644 index 9ce1f85eb17..00000000000 --- a/doc/functions/generators.xml +++ /dev/null @@ -1,74 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xml:id="sec-generators"> - <title>Generators</title> - - <para> - Generators are functions that create file formats from nix data structures, e. g. for configuration files. There are generators available for: <literal>INI</literal>, <literal>JSON</literal> and <literal>YAML</literal> - </para> - - <para> - All generators follow a similar call interface: <code>generatorName configFunctions data</code>, where <literal>configFunctions</literal> is an attrset of user-defined functions that format nested parts of the content. They each have common defaults, so often they do not need to be set manually. An example is <code>mkSectionName ? (name: libStr.escape [ "[" "]" ] name)</code> from the <literal>INI</literal> generator. It receives the name of a section and sanitizes it. The default <literal>mkSectionName</literal> escapes <literal>[</literal> and <literal>]</literal> with a backslash. - </para> - - <para> - Generators can be fine-tuned to produce exactly the file format required by your application/service. One example is an INI-file format which uses <literal>: </literal> as separator, the strings <literal>"yes"</literal>/<literal>"no"</literal> as boolean values and requires all string values to be quoted: - </para> - -<programlisting> -with lib; -let - customToINI = generators.toINI { - # specifies how to format a key/value pair - mkKeyValue = generators.mkKeyValueDefault { - # specifies the generated string for a subset of nix values - mkValueString = v: - if v == true then ''"yes"'' - else if v == false then ''"no"'' - else if isString v then ''"${v}"'' - # and delegats all other values to the default generator - else generators.mkValueStringDefault {} v; - } ":"; - }; - -# the INI file can now be given as plain old nix values -in customToINI { - main = { - pushinfo = true; - autopush = false; - host = "localhost"; - port = 42; - }; - mergetool = { - merge = "diff3"; - }; -} -</programlisting> - - <para> - This will produce the following INI file as nix string: - </para> - -<programlisting> -[main] -autopush:"no" -host:"localhost" -port:42 -pushinfo:"yes" -str\:ange:"very::strange" - -[mergetool] -merge:"diff3" -</programlisting> - - <note> - <para> - Nix store paths can be converted to strings by enclosing a derivation attribute like so: <code>"${drv}"</code>. - </para> - </note> - - <para> - Detailed documentation for each generator can be found in <literal>lib/generators.nix</literal>. - </para> -</section> |