nordic-dev.net/nix
nordic-dev.net/nix
2
0
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2024-11-22 14:52:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Put examples first in the manpages

Browse Source
This commit is contained in:
Eelco Dolstra 2020-12-02 23:19:16 +01:00
parent 72428e38d9
commit e2efc63979
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/manual/generate-manpage.nix
View File

@ -20,6 +20,11 @@ let
(attrNames def.commands))
+ "\n"
else "")
+ (if def.examples or [] != []
then
"# Examples\n\n"
+ concatStrings (map ({ description, command }: "${description}\n\n```console\n${command}\n```\n\n") def.examples)
else "")
+ (if def ? doc
then "# Description\n\n" + def.doc + "\n\n"
else "")
@ -27,11 +32,7 @@ let
if s != ""
then "# Flags\n\n${s}"
else "")
+ (if def.examples or [] != []
then
"# Examples\n\n"
+ concatStrings (map ({ description, command }: "${description}\n\n```console\n${command}\n```\n\n") def.examples)
else "");
;
appendName = filename: name: (if filename == "nix" then "nix3" else filename) + "-" + name;