Skip to content

Commit

Permalink
Merge branch 'print-common-flags' of github.com:Hoverbear/nix
Browse files Browse the repository at this point in the history
  • Loading branch information
edolstra committed Oct 12, 2022
2 parents f3193ed + 069409d commit ae2d330
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
22 changes: 13 additions & 9 deletions doc/manual/generate-manpage.nix
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{ command }:
{ toplevel }:

with builtins;
with import ./utils.nix;

let

showCommand = { command, details, filename }:
showCommand = { command, details, filename, toplevel }:
let
result = ''
> **Warning** \
Expand Down Expand Up @@ -57,14 +57,15 @@ let
maybeOptions = if details.flags == {} then "" else ''
# Options
${showOptions details.flags}
${showOptions details.flags toplevel.flags}
'';
showOptions = options:
showOptions = options: commonOptions:
let
allOptions = options // commonOptions;
showCategory = cat: ''
${if cat != "" then "**${cat}:**" else ""}
${listOptions (filterAttrs (n: v: v.category == cat) options)}
${listOptions (filterAttrs (n: v: v.category == cat) allOptions)}
'';
listOptions = opts: concatStringsSep "\n" (attrValues (mapAttrs showOption opts));
showOption = name: option:
Expand All @@ -76,30 +77,33 @@ let
${option.description}
'';
categories = sort builtins.lessThan (unique (map (cmd: cmd.category) (attrValues options)));
categories = sort builtins.lessThan (unique (map (cmd: cmd.category) (attrValues allOptions)));
in concatStrings (map showCategory categories);
in squash result;

appendName = filename: name: (if filename == "nix" then "nix3" else filename) + "-" + name;

processCommand = { command, details, filename }:
processCommand = { command, details, filename, toplevel }:
let
cmd = {
inherit command;
name = filename + ".md";
value = showCommand { inherit command details filename; };
value = showCommand { inherit command details filename toplevel; };
};
subcommand = subCmd: processCommand {
command = command + " " + subCmd;
details = details.commands.${subCmd};
filename = appendName filename subCmd;
inherit toplevel;
};
in [ cmd ] ++ concatMap subcommand (attrNames details.commands or {});

parsedToplevel = builtins.fromJSON toplevel;
manpages = processCommand {
command = "nix";
details = builtins.fromJSON command;
details = parsedToplevel;
filename = "nix";
toplevel = parsedToplevel;
};

tableOfContents = let
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/local.mk
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ $(d)/src/SUMMARY.md: $(d)/src/SUMMARY.md.in $(d)/src/command-ref/new-cli

$(d)/src/command-ref/new-cli: $(d)/nix.json $(d)/generate-manpage.nix $(bindir)/nix
@rm -rf $@
$(trace-gen) $(nix-eval) --write-to $@ --expr 'import doc/manual/generate-manpage.nix { command = builtins.readFile $<; }'
$(trace-gen) $(nix-eval) --write-to $@ --expr 'import doc/manual/generate-manpage.nix { toplevel = builtins.readFile $<; }'

$(d)/src/command-ref/conf-file.md: $(d)/conf-file.json $(d)/generate-options.nix $(d)/src/command-ref/conf-file-prefix.md $(bindir)/nix
@cat doc/manual/src/command-ref/conf-file-prefix.md > $@.tmp
Expand Down
2 changes: 1 addition & 1 deletion src/nix/main.cc
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ static void showHelp(std::vector<std::string> subcommand, MultiCommand & topleve
*vUtils);

auto attrs = state.buildBindings(16);
attrs.alloc("command").mkString(toplevel.toJSON().dump());
attrs.alloc("toplevel").mkString(toplevel.toJSON().dump());

auto vRes = state.allocValue();
state.callFunction(*vGenerateManpage, state.allocValue()->mkAttrs(attrs), *vRes, noPos);
Expand Down

0 comments on commit ae2d330

Please sign in to comment.