Document the nixpkgs-channels repo

This replaces update-channel-branches.sh with standard Git
invocations.
This commit is contained in:
Eelco Dolstra 2015-05-20 14:16:00 +02:00
parent e98da673e4
commit 10ce7ae769

View File

@ -24,6 +24,9 @@ $ mkdir -p <replaceable>/my/sources</replaceable>
$ cd <replaceable>/my/sources</replaceable> $ cd <replaceable>/my/sources</replaceable>
$ nix-env -i git $ nix-env -i git
$ git clone git://github.com/NixOS/nixpkgs.git $ git clone git://github.com/NixOS/nixpkgs.git
$ cd nixpkgs
$ git remote add channels git://github.com/NixOS/nixpkgs-channels.git
$ git remote update channels
</screen> </screen>
This will check out the latest NixOS sources to This will check out the latest NixOS sources to
@ -31,7 +34,12 @@ This will check out the latest NixOS sources to
and the Nixpkgs sources to and the Nixpkgs sources to
<filename><replaceable>/my/sources</replaceable>/nixpkgs</filename>. <filename><replaceable>/my/sources</replaceable>/nixpkgs</filename>.
(The NixOS source tree lives in a subdirectory of the Nixpkgs (The NixOS source tree lives in a subdirectory of the Nixpkgs
repository.)</para> repository.) The remote <literal>channels</literal> refers to a
read-only repository that tracks the Nixpkgs/NixOS channels (see <xref
linkend="sec-upgrading"/> for more information about channels). Thus,
the Git branch <literal>channels/nixos-14.12</literal> will contain
the latest built and tested version available in the
<literal>nixos-14.12</literal> channel.</para>
<para>Its often inconvenient to develop directly on the master <para>Its often inconvenient to develop directly on the master
branch, since if somebody has just committed (say) a change to GCC, branch, since if somebody has just committed (say) a change to GCC,
@ -40,28 +48,32 @@ rebuild everything from source. So you may want to create a local
branch based on your current NixOS version: branch based on your current NixOS version:
<screen> <screen>
$ <replaceable>/my/sources</replaceable>/nixpkgs/maintainers/scripts/update-channel-branches.sh $ nixos-version
Fetching channels from https://nixos.org/channels: 14.04.273.ea1952b (Baboon)
* [new branch] cbe467e -> channels/remotes/nixos-unstable
Fetching channels from nixos-version: $ git checkout -b local ea1952b
* [new branch] 9ff4738 -> channels/current-system
Fetching channels from ~/.nix-defexpr:
* [new branch] 0d4acad -> channels/root/nixos
$ git checkout -b local channels/current-system
</screen> </screen>
Or, to base your local branch on the latest version available in the Or, to base your local branch on the latest version available in a
NixOS channel: NixOS channel:
<screen> <screen>
$ <replaceable>/my/sources</replaceable>/nixpkgs/maintainers/scripts/update-channel-branches.sh $ git remote update channels
$ git checkout -b local channels/remotes/nixos-unstable $ git checkout -b local channels/nixos-14.12
</screen> </screen>
You can then use <command>git rebase</command> to sync your local (Replace <literal>nixos-14.12</literal> with the name of the channel
branch with the upstream branch, and use <command>git you want to use.) You can use <command>git merge</command> or
cherry-pick</command> to copy commits from your local branch to the <command>git rebase</command> to keep your local branch in sync with
upstream branch.</para> the channel, e.g.
<screen>
$ git remote update channels
$ git merge channels/nixos-14.12
</screen>
You can use <command>git cherry-pick</command> to copy commits from
your local branch to the upstream branch.</para>
<para>If you want to rebuild your system using your (modified) <para>If you want to rebuild your system using your (modified)
sources, you need to tell <command>nixos-rebuild</command> about them sources, you need to tell <command>nixos-rebuild</command> about them