diff options
| author | John Ericson <John.Ericson@Obsidian.Systems> | 2023-05-15 07:11:47 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-15 07:11:47 -0400 |
| commit | 914672dc4f955afc3478c256145e7f6098b7da63 (patch) | |
| tree | 9a68fca94fa52226916a25885999b707cb8ed2bb /doc/manual/src/command-ref/nix-channel.md | |
| parent | b15cba03c394962f274852d08f9274249afe0f49 (diff) | |
| parent | 992be330ab31be4fe226b09fb602ced18fda788c (diff) | |
Merge pull request #8141 from tweag/user-files-doc
Document user files of nix
Diffstat (limited to 'doc/manual/src/command-ref/nix-channel.md')
| -rw-r--r-- | doc/manual/src/command-ref/nix-channel.md | 30 |
1 files changed, 3 insertions, 27 deletions
diff --git a/doc/manual/src/command-ref/nix-channel.md b/doc/manual/src/command-ref/nix-channel.md index 2027cc98d..72d3e422b 100644 --- a/doc/manual/src/command-ref/nix-channel.md +++ b/doc/manual/src/command-ref/nix-channel.md @@ -22,6 +22,9 @@ This command has the following operations: channels. If *name* is omitted, it defaults to the last component of *url*, with the suffixes `-stable` or `-unstable` removed. + A channel URL must point to a directory containing a file `nixexprs.tar.gz`. + At the top level, that tarball must contain a single directory with a `default.nix` file that serves as the channel’s entry point. + - `--remove` *name*\ Removes the channel named *name* from the list of subscribed channels. @@ -71,30 +74,3 @@ switching from generation 483 to 482 $ nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version' "14.04.526.dbadfad" ``` - -# Files - - - `${XDG_STATE_HOME-$HOME/.local/state}/nix/profiles/channels`\ - `nix-channel` uses a `nix-env` profile to keep track of previous - versions of the subscribed channels. Every time you run `nix-channel - --update`, a new channel generation (that is, a symlink to the - channel Nix expressions in the Nix store) is created. This enables - `nix-channel --rollback` to revert to previous versions. - - - `~/.nix-defexpr/channels`\ - This is a symlink to - `${XDG_STATE_HOME-$HOME/.local/state}/nix/profiles/channels`. It ensures that - `nix-env` can find your channels. In a multi-user installation, you - may also have `~/.nix-defexpr/channels_root`, which links to the - channels of the root user. - -# Channel format - -A channel URL should point to a directory containing the following -files: - - - `nixexprs.tar.xz`\ - A tarball containing Nix expressions and files referenced by them - (such as build scripts and patches). At the top level, the tarball - should contain a single directory. That directory must contain a - file `default.nix` that serves as the channel’s “entry point”. |