From 8a93b5a55184d9d34effdd94d58429c9ad1a3d14 Mon Sep 17 00:00:00 2001 From: Alexander Bantyev Date: Fri, 17 Feb 2023 21:57:15 +0400 Subject: Document user files of nix --- doc/manual/src/command-ref/files/channels.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 doc/manual/src/command-ref/files/channels.md (limited to 'doc/manual/src/command-ref/files/channels.md') diff --git a/doc/manual/src/command-ref/files/channels.md b/doc/manual/src/command-ref/files/channels.md new file mode 100644 index 000000000..6ef2527e5 --- /dev/null +++ b/doc/manual/src/command-ref/files/channels.md @@ -0,0 +1,26 @@ +# Channels + +A directory containing symlinks to Nix channels, managed by [`nix-channel`]. + +- `$NIX_STATE_DIR/profiles/per-user/root/channels` for `root` +- `$XDG_STATE_HOME/nix/profiles/channels` for regular users + +[`nix-channel`] uses a [profile](@docroot@/command-ref/files/user-profiles.md) to store channels. +This profile contains symlinks to the contents of those channels. + +## Subscribed channels + +The list of subscribed channels is stored in + +- `~/.nix-channels` +- `$XDG_STATE_HOME/nix/channels` if [`use-xdg-base-directories`] is set to `true` + +in the following format: + +``` + +... +``` + +[`nix-channel`]: @docroot@/command-ref/nix-channel.md +[`use-xdg-base-directories`]: @docroot@/command-ref/conf-file.md#conf-use-xdg-base-directories -- cgit v1.2.3 From a1c996dc7ea32563605c75eae6c209786ac3b9b2 Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Wed, 26 Apr 2023 10:56:35 +0200 Subject: list information regular users first this is to make it consistent everywhere --- doc/manual/src/command-ref/files/channels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/manual/src/command-ref/files/channels.md') diff --git a/doc/manual/src/command-ref/files/channels.md b/doc/manual/src/command-ref/files/channels.md index 6ef2527e5..2d1c2c160 100644 --- a/doc/manual/src/command-ref/files/channels.md +++ b/doc/manual/src/command-ref/files/channels.md @@ -2,8 +2,8 @@ A directory containing symlinks to Nix channels, managed by [`nix-channel`]. -- `$NIX_STATE_DIR/profiles/per-user/root/channels` for `root` - `$XDG_STATE_HOME/nix/profiles/channels` for regular users +- `$NIX_STATE_DIR/profiles/per-user/root/channels` for `root` [`nix-channel`] uses a [profile](@docroot@/command-ref/files/user-profiles.md) to store channels. This profile contains symlinks to the contents of those channels. -- cgit v1.2.3 From 9d386fe2ee79d5fadea3c29559687bd0df4c8e5b Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Wed, 26 Apr 2023 10:57:41 +0200 Subject: add colons to connect listings with descriptions --- doc/manual/src/command-ref/files/channels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/manual/src/command-ref/files/channels.md') diff --git a/doc/manual/src/command-ref/files/channels.md b/doc/manual/src/command-ref/files/channels.md index 2d1c2c160..88db66165 100644 --- a/doc/manual/src/command-ref/files/channels.md +++ b/doc/manual/src/command-ref/files/channels.md @@ -1,6 +1,6 @@ # Channels -A directory containing symlinks to Nix channels, managed by [`nix-channel`]. +A directory containing symlinks to Nix channels, managed by [`nix-channel`]: - `$XDG_STATE_HOME/nix/profiles/channels` for regular users - `$NIX_STATE_DIR/profiles/per-user/root/channels` for `root` -- cgit v1.2.3 From 219aaf5a0b78e09891557f15c16d3376d401c471 Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Wed, 26 Apr 2023 15:07:26 +0200 Subject: increase heading level otherwise the headings won't match at the point where they are included. this is a bit hacky and brittle, but works for now. --- doc/manual/src/command-ref/files/channels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/manual/src/command-ref/files/channels.md') diff --git a/doc/manual/src/command-ref/files/channels.md b/doc/manual/src/command-ref/files/channels.md index 88db66165..c680c747a 100644 --- a/doc/manual/src/command-ref/files/channels.md +++ b/doc/manual/src/command-ref/files/channels.md @@ -1,4 +1,4 @@ -# Channels +## Channels A directory containing symlinks to Nix channels, managed by [`nix-channel`]: -- cgit v1.2.3 From f8620758aad1e3b61bc2d10a913bfd07c6d21df6 Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Thu, 27 Apr 2023 11:56:52 +0200 Subject: display documentation on manifest files separately it's probably better not to show the manifest file documentation in the command-specific pages, because these are implementation details that are not really practically useful. this means no additional hassle for building the manual, but clutters the table of contents a bit. --- doc/manual/src/command-ref/files/channels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/manual/src/command-ref/files/channels.md') diff --git a/doc/manual/src/command-ref/files/channels.md b/doc/manual/src/command-ref/files/channels.md index c680c747a..7b1f27128 100644 --- a/doc/manual/src/command-ref/files/channels.md +++ b/doc/manual/src/command-ref/files/channels.md @@ -5,7 +5,7 @@ A directory containing symlinks to Nix channels, managed by [`nix-channel`]: - `$XDG_STATE_HOME/nix/profiles/channels` for regular users - `$NIX_STATE_DIR/profiles/per-user/root/channels` for `root` -[`nix-channel`] uses a [profile](@docroot@/command-ref/files/user-profiles.md) to store channels. +[`nix-channel`] uses a [profile](@docroot@/command-ref/files/profiles.md) to store channels. This profile contains symlinks to the contents of those channels. ## Subscribed channels -- cgit v1.2.3