aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorIsabel <isabel@isabelroses.com>2024-08-02 07:56:06 +0000
committerGerrit Code Review <gerrit@localhost>2024-08-02 07:56:06 +0000
commit9eb374dc6da5cd0e8f96522342a5b0a27fc5946b (patch)
tree69b559e54e4433b501a4ae2ef60944dd90cc40f2 /doc
parent3bb8c627aecc4abd89e7863cc11a7aef1ee74ed7 (diff)
parentd2422771eb8e4186841ebab8ef486328e9a07d28 (diff)
Merge "nix flake show: add the description if it exists" into main
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/change-authors.yml7
-rw-r--r--doc/manual/rl-next/nix-flake-show-description.md37
2 files changed, 44 insertions, 0 deletions
diff --git a/doc/manual/change-authors.yml b/doc/manual/change-authors.yml
index 775149180..630af29ff 100644
--- a/doc/manual/change-authors.yml
+++ b/doc/manual/change-authors.yml
@@ -70,10 +70,17 @@ horrors:
iFreilicht:
github: iFreilicht
+isabelroses:
+ forgejo: isabelroses
+ github: isabelroses
+
jade:
forgejo: jade
github: lf-
+kjeremy:
+ github: kjeremy
+
kloenk:
forgejo: kloenk
github: kloenk
diff --git a/doc/manual/rl-next/nix-flake-show-description.md b/doc/manual/rl-next/nix-flake-show-description.md
new file mode 100644
index 000000000..e819a3a29
--- /dev/null
+++ b/doc/manual/rl-next/nix-flake-show-description.md
@@ -0,0 +1,37 @@
+---
+synopsis: "Lix will now show the package descriptions in when running `nix flake show`."
+cls: [1540]
+issues: []
+credits: [kjeremy, isabelroses]
+category: Improvements
+---
+
+When running `nix flake show`, Lix will now show the package descriptions, if they exist.
+
+Before:
+
+```shell
+$ nix flake show
+path:/home/isabel/dev/lix-show?lastModified=1721736108&narHash=sha256-Zo8HP1ur7Q2b39hKUEG8EAh/opgq8xJ2jvwQ/htwO4Q%3D
+└───packages
+ └───x86_64-linux
+ ├───aNoDescription: package 'simple'
+ ├───bOneLineDescription: package 'simple'
+ ├───cMultiLineDescription: package 'simple'
+ ├───dLongDescription: package 'simple'
+ └───eEmptyDescription: package 'simple'
+```
+
+After:
+
+```shell
+$ nix flake show
+path:/home/isabel/dev/lix-show?lastModified=1721736108&narHash=sha256-Zo8HP1ur7Q2b39hKUEG8EAh/opgq8xJ2jvwQ/htwO4Q%3D
+└───packages
+ └───x86_64-linux
+ ├───aNoDescription: package 'simple'
+ ├───bOneLineDescription: package 'simple' - 'one line'
+ ├───cMultiLineDescription: package 'simple' - 'line one'
+ ├───dLongDescription: package 'simple' - 'abcdefghijklmnopqrstuvwxyz'
+ └───eEmptyDescription: package 'simple'
+```