nixos/rfcs
1
0
Fork 0
mirror of https://github.com/NixOS/rfcs.git synced 2025-12-24 18:01:04 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

(Flake names) Move & demote interactions

Browse source
This commit is contained in:
Anselm Schüler 2022-03-13 19:54:33 +01:00 • committed by GitHub
parent 23e44a1d90
commit bb09d85b02
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
rfcs/0123-flake-names.md
View file

@ -25,14 +25,15 @@ Also, the discoverability and usability of flakes needs to be improved. Current
[design]: #detailed-design
A new supported property for flakes is introduced, `name`.
Running `nix flake metadata` on a flake that declares this field displays it at the top.
Running `nix flake show` on a flake that declares this field shows the name instead of the URL, followed by the URL in parentheses.
The derivation that contains the flake’s content is called `flake-source-${name}` or, if a short revision identifier is available, `flake-source-${name}-${shortRev}`.
# Examples and Interactions
[examples-and-interactions]: #examples-and-interactions
Example:
Running `nix flake metadata` on a flake that declares this field displays it at the top.
Running `nix flake show` on a flake that declares this field shows the name instead of the URL, followed by the URL in parentheses.
Examples:
File `/example/flake.nix`
```nix
@ -47,8 +48,14 @@ File `/example/flake.nix`
Shell
```console
$ nix eval git+file:///example
[…] copying flake-source-example
[…] copying flake-source-example-e1279e9
"example"
```
Example of interactions:
Shell (using the previous file)
```
$ nix flake metadata /example
Name: example
Resolved URL: git+file:///example