Merge pull request #7661 from henrik-ch/repl-doc

improved help command listing.
This commit is contained in:
Théophane Hufschmitt 2023-09-14 16:43:02 +02:00 committed by GitHub
commit 2a52ec4e92
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -488,35 +488,40 @@ bool NixRepl::processLine(std::string line)
std::cout std::cout
<< "The following commands are available:\n" << "The following commands are available:\n"
<< "\n" << "\n"
<< " <expr> Evaluate and print expression\n" << " <expr> Evaluate and print expression\n"
<< " <x> = <expr> Bind expression to variable\n" << " <x> = <expr> Bind expression to variable\n"
<< " :a <expr> Add attributes from resulting set to scope\n" << " :a, :add <expr> Add attributes from resulting set to scope\n"
<< " :b <expr> Build a derivation\n" << " :b <expr> Build a derivation\n"
<< " :bl <expr> Build a derivation, creating GC roots in the working directory\n" << " :bl <expr> Build a derivation, creating GC roots in the\n"
<< " :e <expr> Open package or function in $EDITOR\n" << " working directory\n"
<< " :i <expr> Build derivation, then install result into current profile\n" << " :e, :edit <expr> Open package or function in $EDITOR\n"
<< " :l <path> Load Nix expression and add it to scope\n" << " :i <expr> Build derivation, then install result into\n"
<< " :lf <ref> Load Nix flake and add it to scope\n" << " current profile\n"
<< " :p <expr> Evaluate and print expression recursively\n" << " :l, :load <path> Load Nix expression and add it to scope\n"
<< " :q Exit nix-repl\n" << " :lf, :load-flake <ref> Load Nix flake and add it to scope\n"
<< " :r Reload all files\n" << " :p, :print <expr> Evaluate and print expression recursively\n"
<< " :sh <expr> Build dependencies of derivation, then start nix-shell\n" << " :q, :quit Exit nix-repl\n"
<< " :t <expr> Describe result of evaluation\n" << " :r, :reload Reload all files\n"
<< " :u <expr> Build derivation, then start nix-shell\n" << " :sh <expr> Build dependencies of derivation, then start\n"
<< " :doc <expr> Show documentation of a builtin function\n" << " nix-shell\n"
<< " :log <expr> Show logs for a derivation\n" << " :t <expr> Describe result of evaluation\n"
<< " :te [bool] Enable, disable or toggle showing traces for errors\n" << " :u <expr> Build derivation, then start nix-shell\n"
<< " :doc <expr> Show documentation of a builtin function\n"
<< " :log <expr> Show logs for a derivation\n"
<< " :te, :trace-enable [bool] Enable, disable or toggle showing traces for\n"
<< " errors\n"
<< " :?, :help Brings up this help menu\n"
; ;
if (state->debugRepl) { if (state->debugRepl) {
std::cout std::cout
<< "\n" << "\n"
<< " Debug mode commands\n" << " Debug mode commands\n"
<< " :env Show env stack\n" << " :env Show env stack\n"
<< " :bt Show trace stack\n" << " :bt, :backtrace Show trace stack\n"
<< " :st Show current trace\n" << " :st Show current trace\n"
<< " :st <idx> Change to another trace in the stack\n" << " :st <idx> Change to another trace in the stack\n"
<< " :c Go until end of program, exception, or builtins.break\n" << " :c, :continue Go until end of program, exception, or builtins.break\n"
<< " :s Go one step\n" << " :s, :step Go one step\n"
; ;
} }