From ab98971f031a4f44797e41085516d8dd4f2ee78d Mon Sep 17 00:00:00 2001 From: Daniel R Date: Mon, 6 Nov 2023 22:11:25 -0400 Subject: [PATCH] move question 'what are channels...?' -f recipes -t concepts (#744) Co-authored-by: Alexander Groleau Co-authored-by: Valentin Gagarin Co-authored-by: Silvan Mosberger --- source/concepts/faq.md | 30 ++++++++++++++++++++++++++++++ source/guides/faq.md | 4 ---- 2 files changed, 30 insertions(+), 4 deletions(-) diff --git a/source/concepts/faq.md b/source/concepts/faq.md index 30b760b..125dc53 100644 --- a/source/concepts/faq.md +++ b/source/concepts/faq.md @@ -60,6 +60,36 @@ There are downsides to relying on [experimental features](https://nixos.org/manu - The [Nix documentation team](https://nixos.org/community/teams/documentation.html) focuses on improving documentation and learning materials for stable features and common principles. When using flakes, you will have to rely more heavily on user-to-user support, third-party documentation, and the source code. +## Which channel branch should I use? + +Nixpkgs and NixOS have both stable and rolling releases. + +### Stable + +- On Linux (including NixOS and WSL), use [`nixos-*`](https://github.com/NixOS/nixpkgs/branches/all?query=nixos-). + + These branches only contain commits that passed the NixOS test suite. +- On any other platform, use [`nixpkgs-*`](https://github.com/NixOS/nixpkgs/branches/all?query=nixpkgs-). + + These branches contain commits that passed the test suites specific to other platforms. + +All of these "channel branches" follow the corresponding [`release-*`](https://github.com/NixOS/nixpkgs/branches/all?query=release-) branch. + +:::{admonition} Example +`nixos-23.05` and `nixpkgs-23.05-darwin` are both based on `release-23.05`. +::: + +### Rolling + +- On Linux (including NixOS and WSL), use [`nixos-unstable`](https://github.com/NixOS/nixpkgs/branches/all?query=nixos-unstable). +- On any other platform, use [`nixpkgs-unstable`](https://github.com/NixOS/nixpkgs/branches/all?query=nixpkgs-unstable). + +These branches follow `master`, the main development development branch. + +[`*-small`](https://github.com/NixOS/nixpkgs/branches/all?query=-small) channel branches have passed a smaller test suite, which means they are more up-to-date with respect to their base branch but offer fewer stability guarantees. + +Consult the [`nix-channel`](https://nixos.org/manual/nix/unstable/command-ref/nix-channel) entry in the Nix Reference Manual for more information on channels, and the [Nixpkgs contributing guide](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#branch-conventions) on the Nixpkgs branching strategy. + ## Are there any impurities left in sandboxed builds? Yes. There is: diff --git a/source/guides/faq.md b/source/guides/faq.md index 310009d..1991b64 100644 --- a/source/guides/faq.md +++ b/source/guides/faq.md @@ -54,10 +54,6 @@ See $ nix-shell -p nixpkgs-review --run "nixpkgs-review wip" ``` -### What are channels and different branches on github? - -See - ### How can I manage dotfiles in \$HOME with Nix? See