max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-22 14:06:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

avoid markdown which the repl's :doc cannot handle

Browse source 
code blocks, if not surrounded by empty lines, have the language
tags (in these cases, always `nix`) show up in the output of :doc.

for example:

  nix-repl> :doc builtins.parseFlakeRef
  Synopsis: builtins.parseFlakeRef flake-ref

    Parse a flake reference, and return its exploded form.

    For example: nix builtins.parseFlakeRef
    "github:NixOS/nixpkgs/23.05?dir=lib"  evaluates to: nix { dir =
    "lib"; owner = "NixOS"; ref = "23.05"; repo = "nixpkgs"; type =
    "github"; }

is now instead:
  nix-repl> :doc builtins.parseFlakeRef
  Synopsis: builtins.parseFlakeRef flake-ref

    Parse a flake reference, and return its exploded form.

    For example:

      | builtins.parseFlakeRef "github:NixOS/nixpkgs/23.05?dir=lib"

    evaluates to:

      | { dir = "lib"; owner = "NixOS"; ref = "23.05"; repo = "nixpkgs"; type = "github"; }
This commit is contained in:
stuebinm 2024-04-05 23:19:32 +02:00
parent 5a365b0c89
commit 910211f9ff
3 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/libexpr/flake/flake.cc
View file

@ -868,10 +868,13 @@ static RegisterPrimOp r3({
Parse a flake reference, and return its exploded form. Parse a flake reference, and return its exploded form.
For example: For example:
```nix ```nix
builtins.parseFlakeRef "github:NixOS/nixpkgs/23.05?dir=lib" builtins.parseFlakeRef "github:NixOS/nixpkgs/23.05?dir=lib"
``` ```
evaluates to: evaluates to:
```nix ```nix
{ dir = "lib"; owner = "NixOS"; ref = "23.05"; repo = "nixpkgs"; type = "github"; } { dir = "lib"; owner = "NixOS"; ref = "23.05"; repo = "nixpkgs"; type = "github"; }
``` ```
@ -920,12 +923,15 @@ static RegisterPrimOp r4({
Convert a flake reference from attribute set format to URL format. Convert a flake reference from attribute set format to URL format.
For example: For example:
```nix ```nix
builtins.flakeRefToString { builtins.flakeRefToString {
dir = "lib"; owner = "NixOS"; ref = "23.05"; repo = "nixpkgs"; type = "github"; dir = "lib"; owner = "NixOS"; ref = "23.05"; repo = "nixpkgs"; type = "github";
} }
``` ```
evaluates to evaluates to
```nix ```nix
"github:NixOS/nixpkgs/23.05?dir=lib" "github:NixOS/nixpkgs/23.05?dir=lib"
``` ```

2
src/libexpr/primops.cc
View file

@ -1915,11 +1915,13 @@ static RegisterPrimOp primop_outputOf({
*`derivation reference`* must be a string that may contain a regular store path to a derivation, or may be a placeholder reference. If the derivation is produced by a derivation, you must explicitly select `drv.outPath`. *`derivation reference`* must be a string that may contain a regular store path to a derivation, or may be a placeholder reference. If the derivation is produced by a derivation, you must explicitly select `drv.outPath`.
This primop can be chained arbitrarily deeply. This primop can be chained arbitrarily deeply.
For instance, For instance,
```nix ```nix
builtins.outputOf builtins.outputOf
(builtins.outputOf myDrv "out") (builtins.outputOf myDrv "out")
"out" "out"
``` ```
will return a placeholder for the output of the output of `myDrv`. will return a placeholder for the output of the output of `myDrv`.
This primop corresponds to the `^` sigil for derivable paths, e.g. as part of installable syntax on the command line. This primop corresponds to the `^` sigil for derivable paths, e.g. as part of installable syntax on the command line.

2
src/libexpr/primops/fetchTree.cc
View file

@ -650,12 +650,14 @@ static RegisterPrimOp primop_fetchGit({
The public keys against which `rev` is verified if `verifyCommit` is enabled. The public keys against which `rev` is verified if `verifyCommit` is enabled.
Must be given as a list of attribute sets with the following form: Must be given as a list of attribute sets with the following form:
```nix ```nix
{ {
key = "<public key>"; key = "<public key>";
type = "<key type>"; # optional, default: "ssh-ed25519" type = "<key type>"; # optional, default: "ssh-ed25519"
} }
``` ```
Requires the [`verified-fetches` experimental feature](@docroot@/contributing/experimental-features.md#xp-feature-verified-fetches). Requires the [`verified-fetches` experimental feature](@docroot@/contributing/experimental-features.md#xp-feature-verified-fetches).