forked from lix-project/lix
Merge remote-tracking branch 'upstream/master' into path-info
Also improve content-address.hh API docs.
This commit is contained in:
John Ericson
commit
aa99005004
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -26,3 +26,7 @@ Maintainers: tick if completed or explain if not relevant
|
||||||
- [ ] code and comments are self-explanatory
|
- [ ] code and comments are self-explanatory
|
||||||
- [ ] commit message explains why the change was made
|
- [ ] commit message explains why the change was made
|
||||||
- [ ] new feature or incompatible change: updated release notes
|
- [ ] new feature or incompatible change: updated release notes
|
||||||
|
|
||||||
|
# Priorities
|
||||||
|
|
||||||
|
Add :+1: to [pull requests you find important](https://github.com/NixOS/nix/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc).
|
||||||
|
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
**Release Notes**
|
|
||||||
Please include relevant [release notes](https://github.com/NixOS/nix/blob/master/doc/manual/src/release-notes/rl-next.md) as needed.
|
|
||||||
|
|
||||||
|
|
||||||
**Testing**
|
|
||||||
|
|
||||||
If this issue is a regression or something that should block release, please consider including a test either in the [testsuite](https://github.com/NixOS/nix/tree/master/tests) or as a [hydraJob]( https://github.com/NixOS/nix/blob/master/flake.nix#L396) so that it can be part of the [automatic checks](https://hydra.nixos.org/jobset/nix/master).
|
|
||||||
|
|
||||||
**Priorities**
|
|
||||||
|
|
||||||
Add :+1: to [pull requests you find important](https://github.com/NixOS/nix/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc).
|
|
||||||
6
.github/labeler.yml
vendored
Normal file
6
.github/labeler.yml
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
"documentation":
|
||||||
|
- doc/manual/*
|
||||||
|
- src/nix/**/*.md
|
||||||
|
|
||||||
|
"tests":
|
||||||
|
- tests/**/*
|
||||||
14
.github/workflows/ci.yml
vendored
14
.github/workflows/ci.yml
vendored
|
|
@ -19,7 +19,7 @@ jobs:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- uses: cachix/install-nix-action@v19
|
- uses: cachix/install-nix-action@v20
|
||||||
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
||||||
- uses: cachix/cachix-action@v12
|
- uses: cachix/cachix-action@v12
|
||||||
if: needs.check_secrets.outputs.cachix == 'true'
|
if: needs.check_secrets.outputs.cachix == 'true'
|
||||||
|
|
@ -58,7 +58,9 @@ jobs:
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
||||||
- uses: cachix/install-nix-action@v19
|
- uses: cachix/install-nix-action@v20
|
||||||
|
with:
|
||||||
|
install_url: https://releases.nixos.org/nix/nix-2.13.3/install
|
||||||
- uses: cachix/cachix-action@v12
|
- uses: cachix/cachix-action@v12
|
||||||
with:
|
with:
|
||||||
name: '${{ env.CACHIX_NAME }}'
|
name: '${{ env.CACHIX_NAME }}'
|
||||||
|
|
@ -77,7 +79,7 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
||||||
- uses: cachix/install-nix-action@v19
|
- uses: cachix/install-nix-action@v20
|
||||||
with:
|
with:
|
||||||
install_url: '${{needs.installer.outputs.installerURL}}'
|
install_url: '${{needs.installer.outputs.installerURL}}'
|
||||||
install_options: "--tarball-url-prefix https://${{ env.CACHIX_NAME }}.cachix.org/serve"
|
install_options: "--tarball-url-prefix https://${{ env.CACHIX_NAME }}.cachix.org/serve"
|
||||||
|
|
@ -89,6 +91,8 @@ jobs:
|
||||||
- run: exec sh -c "nix-instantiate -E 'builtins.currentTime' --eval"
|
- run: exec sh -c "nix-instantiate -E 'builtins.currentTime' --eval"
|
||||||
- run: exec zsh -c "nix-instantiate -E 'builtins.currentTime' --eval"
|
- run: exec zsh -c "nix-instantiate -E 'builtins.currentTime' --eval"
|
||||||
- run: exec fish -c "nix-instantiate -E 'builtins.currentTime' --eval"
|
- run: exec fish -c "nix-instantiate -E 'builtins.currentTime' --eval"
|
||||||
|
- run: exec bash -c "nix-channel --add https://releases.nixos.org/nixos/unstable/nixos-23.05pre466020.60c1d71f2ba nixpkgs"
|
||||||
|
- run: exec bash -c "nix-channel --update && nix-env -iA nixpkgs.hello && hello"
|
||||||
|
|
||||||
docker_push_image:
|
docker_push_image:
|
||||||
needs: [check_secrets, tests]
|
needs: [check_secrets, tests]
|
||||||
|
|
@ -102,7 +106,9 @@ jobs:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- uses: cachix/install-nix-action@v19
|
- uses: cachix/install-nix-action@v20
|
||||||
|
with:
|
||||||
|
install_url: https://releases.nixos.org/nix/nix-2.13.3/install
|
||||||
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
- run: echo CACHIX_NAME="$(echo $GITHUB_REPOSITORY-install-tests | tr "[A-Z]/" "[a-z]-")" >> $GITHUB_ENV
|
||||||
- run: echo NIX_VERSION="$(nix --experimental-features 'nix-command flakes' eval .\#default.version | tr -d \")" >> $GITHUB_ENV
|
- run: echo NIX_VERSION="$(nix --experimental-features 'nix-command flakes' eval .\#default.version | tr -d \")" >> $GITHUB_ENV
|
||||||
- uses: cachix/cachix-action@v12
|
- uses: cachix/cachix-action@v12
|
||||||
|
|
|
||||||
24
.github/workflows/labels.yml
vendored
Normal file
24
.github/workflows/labels.yml
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
name: "Label PR"
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types: [edited, opened, synchronize, reopened]
|
||||||
|
|
||||||
|
# WARNING:
|
||||||
|
# When extending this action, be aware that $GITHUB_TOKEN allows some write
|
||||||
|
# access to the GitHub API. This means that it should not evaluate user input in
|
||||||
|
# a way that allows code injection.
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pull-requests: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
labels:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.repository_owner == 'NixOS'
|
||||||
|
steps:
|
||||||
|
- uses: actions/labeler@v4
|
||||||
|
with:
|
||||||
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
sync-labels: true
|
||||||
61
CONTRIBUTING.md
Normal file
61
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
# Contributing to Nix
|
||||||
|
|
||||||
|
Welcome and thank you for your interest in contributing to Nix!
|
||||||
|
We appreciate your support.
|
||||||
|
|
||||||
|
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved.
|
||||||
|
|
||||||
|
|
||||||
|
## Report a bug
|
||||||
|
|
||||||
|
1. Check on the [GitHub issue tracker](https://github.com/NixOS/nix/issues) if your bug was already reported.
|
||||||
|
|
||||||
|
2. If you were not able to find the bug or feature [open a new issue](https://github.com/NixOS/nix/issues/new/choose)
|
||||||
|
|
||||||
|
3. The issue templates will guide you in specifying your issue.
|
||||||
|
The more complete the information you provide, the more likely it can be found by others and the more useful it is in the future.
|
||||||
|
Make sure reported bugs can be reproduced easily.
|
||||||
|
|
||||||
|
4. Once submitted, do not expect issues to be picked up or solved right away.
|
||||||
|
The only way to ensure this, is to [work on the issue yourself](#making-changes-to-nix).
|
||||||
|
|
||||||
|
## Report a security vulnerability
|
||||||
|
|
||||||
|
Check out the [security policy](https://github.com/NixOS/nix/security/policy).
|
||||||
|
|
||||||
|
## Making changes to Nix
|
||||||
|
|
||||||
|
1. Check for [pull requests](https://github.com/NixOS/nix/pulls) that might already cover the contribution you are about to make.
|
||||||
|
There are many open pull requests that might already do what you intent to work on.
|
||||||
|
You can use [labels](https://github.com/NixOS/nix/labels) to filter for relevant topics.
|
||||||
|
|
||||||
|
2. Search for related issues that cover what you're going to work on. It could help to mention there that you will work on the issue.
|
||||||
|
|
||||||
|
3. Check the [Nix reference manual](https://nixos.org/manual/nix/unstable/contributing/hacking.html) for information on building Nix and running its tests.
|
||||||
|
|
||||||
|
For contributions to the command line interface, please check the [CLI guidelines](https://nixos.org/manual/nix/unstable/contributing/cli-guideline.html).
|
||||||
|
|
||||||
|
4. Make your changes!
|
||||||
|
|
||||||
|
5. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for your changes.
|
||||||
|
* [Mark the pull request as draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request) if you're not done with the changes.
|
||||||
|
* Make sure to have [a clean history of commits on your branch by using rebase](https://www.digitalocean.com/community/tutorials/how-to-rebase-and-update-a-pull-request).
|
||||||
|
* Link related issues in your pull request to inform interested parties and future contributors about your change.
|
||||||
|
If your pull request closes one or multiple issues, note that in the description using `Closes: #<number>`, as it will then happen automatically when your change is merged.
|
||||||
|
|
||||||
|
6. Do not expect your pull request to be reviewed immediately.
|
||||||
|
Nix maintainers follow a [structured process for reviews and design decisions](https://github.com/NixOS/nix/tree/master/maintainers#project-board-protocol), which may or may not prioritise your work.
|
||||||
|
|
||||||
|
7. If you need additional feedback or help to getting pull request into shape, ask other contributors using [@mentions](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#mentioning-people-and-teams).
|
||||||
|
|
||||||
|
## Making changes to the Nix manual
|
||||||
|
|
||||||
|
The Nix reference manual is hosted on https://nixos.org/manual/nix.
|
||||||
|
The underlying source files are located in [`doc/manual/src`](./doc/manual/src).
|
||||||
|
For small changes you can [use GitHub to edit these files](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files)
|
||||||
|
For larger changes see the [Nix reference manual](https://nixos.org/manual/nix/unstable/contributing/hacking.html).
|
||||||
|
|
||||||
|
## Getting help
|
||||||
|
|
||||||
|
Whenever you're stuck or do not know how to proceed, you can always ask for help.
|
||||||
|
The appropriate channels to do so can be found on the [NixOS Community](https://nixos.org/community/) page.
|
||||||
18
Makefile
18
Makefile
|
|
@ -2,13 +2,10 @@ makefiles = \
|
||||||
mk/precompiled-headers.mk \
|
mk/precompiled-headers.mk \
|
||||||
local.mk \
|
local.mk \
|
||||||
src/libutil/local.mk \
|
src/libutil/local.mk \
|
||||||
src/libutil/tests/local.mk \
|
|
||||||
src/libstore/local.mk \
|
src/libstore/local.mk \
|
||||||
src/libstore/tests/local.mk \
|
|
||||||
src/libfetchers/local.mk \
|
src/libfetchers/local.mk \
|
||||||
src/libmain/local.mk \
|
src/libmain/local.mk \
|
||||||
src/libexpr/local.mk \
|
src/libexpr/local.mk \
|
||||||
src/libexpr/tests/local.mk \
|
|
||||||
src/libcmd/local.mk \
|
src/libcmd/local.mk \
|
||||||
src/nix/local.mk \
|
src/nix/local.mk \
|
||||||
src/resolve-system-dependencies/local.mk \
|
src/resolve-system-dependencies/local.mk \
|
||||||
|
|
@ -20,11 +17,22 @@ makefiles = \
|
||||||
misc/launchd/local.mk \
|
misc/launchd/local.mk \
|
||||||
misc/upstart/local.mk \
|
misc/upstart/local.mk \
|
||||||
doc/manual/local.mk \
|
doc/manual/local.mk \
|
||||||
tests/local.mk \
|
doc/internal-api/local.mk
|
||||||
tests/plugins/local.mk
|
|
||||||
|
|
||||||
-include Makefile.config
|
-include Makefile.config
|
||||||
|
|
||||||
|
ifeq ($(tests), yes)
|
||||||
|
makefiles += \
|
||||||
|
src/libutil/tests/local.mk \
|
||||||
|
src/libstore/tests/local.mk \
|
||||||
|
src/libexpr/tests/local.mk \
|
||||||
|
tests/local.mk \
|
||||||
|
tests/plugins/local.mk
|
||||||
|
else
|
||||||
|
makefiles += \
|
||||||
|
mk/disable-tests.mk
|
||||||
|
endif
|
||||||
|
|
||||||
OPTIMIZE = 1
|
OPTIMIZE = 1
|
||||||
|
|
||||||
ifeq ($(OPTIMIZE), 1)
|
ifeq ($(OPTIMIZE), 1)
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,7 @@ LOWDOWN_LIBS = @LOWDOWN_LIBS@
|
||||||
OPENSSL_LIBS = @OPENSSL_LIBS@
|
OPENSSL_LIBS = @OPENSSL_LIBS@
|
||||||
PACKAGE_NAME = @PACKAGE_NAME@
|
PACKAGE_NAME = @PACKAGE_NAME@
|
||||||
PACKAGE_VERSION = @PACKAGE_VERSION@
|
PACKAGE_VERSION = @PACKAGE_VERSION@
|
||||||
|
RAPIDCHECK_HEADERS = @RAPIDCHECK_HEADERS@
|
||||||
SHELL = @bash@
|
SHELL = @bash@
|
||||||
SODIUM_LIBS = @SODIUM_LIBS@
|
SODIUM_LIBS = @SODIUM_LIBS@
|
||||||
SQLITE3_LIBS = @SQLITE3_LIBS@
|
SQLITE3_LIBS = @SQLITE3_LIBS@
|
||||||
|
|
@ -45,3 +46,5 @@ sandbox_shell = @sandbox_shell@
|
||||||
storedir = @storedir@
|
storedir = @storedir@
|
||||||
sysconfdir = @sysconfdir@
|
sysconfdir = @sysconfdir@
|
||||||
system = @system@
|
system = @system@
|
||||||
|
tests = @tests@
|
||||||
|
internal_api_docs = @internal_api_docs@
|
||||||
|
|
|
||||||
17
configure.ac
17
configure.ac
|
|
@ -145,6 +145,18 @@ if test "x$GCC_ATOMIC_BUILTINS_NEED_LIBATOMIC" = xyes; then
|
||||||
LDFLAGS="-latomic $LDFLAGS"
|
LDFLAGS="-latomic $LDFLAGS"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Building without tests is useful for bootstrapping with a smaller footprint
|
||||||
|
# or running the tests in a separate derivation. Otherwise, we do compile and
|
||||||
|
# run them.
|
||||||
|
AC_ARG_ENABLE(tests, AS_HELP_STRING([--disable-tests],[Do not build the tests]),
|
||||||
|
tests=$enableval, tests=yes)
|
||||||
|
AC_SUBST(tests)
|
||||||
|
|
||||||
|
# Building without API docs is the default as Nix' C++ interfaces are internal and unstable.
|
||||||
|
AC_ARG_ENABLE(internal_api_docs, AS_HELP_STRING([--enable-internal-api-docs],[Build API docs for Nix's internal unstable C++ interfaces]),
|
||||||
|
internal_api_docs=$enableval, internal_api_docs=no)
|
||||||
|
AC_SUBST(internal_api_docs)
|
||||||
|
|
||||||
# LTO is currently broken with clang for unknown reasons; ld segfaults in the llvm plugin
|
# LTO is currently broken with clang for unknown reasons; ld segfaults in the llvm plugin
|
||||||
AC_ARG_ENABLE(lto, AS_HELP_STRING([--enable-lto],[Enable LTO (only supported with GCC) [default=no]]),
|
AC_ARG_ENABLE(lto, AS_HELP_STRING([--enable-lto],[Enable LTO (only supported with GCC) [default=no]]),
|
||||||
lto=$enableval, lto=no)
|
lto=$enableval, lto=no)
|
||||||
|
|
@ -270,6 +282,8 @@ if test "$gc" = yes; then
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
if test "$tests" = yes; then
|
||||||
|
|
||||||
# Look for gtest.
|
# Look for gtest.
|
||||||
PKG_CHECK_MODULES([GTEST], [gtest_main])
|
PKG_CHECK_MODULES([GTEST], [gtest_main])
|
||||||
|
|
||||||
|
|
@ -277,11 +291,14 @@ PKG_CHECK_MODULES([GTEST], [gtest_main])
|
||||||
# Look for rapidcheck.
|
# Look for rapidcheck.
|
||||||
# No pkg-config yet, https://github.com/emil-e/rapidcheck/issues/302
|
# No pkg-config yet, https://github.com/emil-e/rapidcheck/issues/302
|
||||||
AC_LANG_PUSH(C++)
|
AC_LANG_PUSH(C++)
|
||||||
|
AC_SUBST(RAPIDCHECK_HEADERS)
|
||||||
|
[CXXFLAGS="-I $RAPIDCHECK_HEADERS $CXXFLAGS"]
|
||||||
AC_CHECK_HEADERS([rapidcheck/gtest.h], [], [], [#include <gtest/gtest.h>])
|
AC_CHECK_HEADERS([rapidcheck/gtest.h], [], [], [#include <gtest/gtest.h>])
|
||||||
dnl No good for C++ libs with mangled symbols
|
dnl No good for C++ libs with mangled symbols
|
||||||
dnl AC_CHECK_LIB([rapidcheck], [])
|
dnl AC_CHECK_LIB([rapidcheck], [])
|
||||||
AC_LANG_POP(C++)
|
AC_LANG_POP(C++)
|
||||||
|
|
||||||
|
fi
|
||||||
|
|
||||||
# Look for nlohmann/json.
|
# Look for nlohmann/json.
|
||||||
PKG_CHECK_MODULES([NLOHMANN_JSON], [nlohmann_json >= 3.9])
|
PKG_CHECK_MODULES([NLOHMANN_JSON], [nlohmann_json >= 3.9])
|
||||||
|
|
|
||||||
13
default.nix
13
default.nix
|
|
@ -1,3 +1,10 @@
|
||||||
(import (fetchTarball "https://github.com/edolstra/flake-compat/archive/master.tar.gz") {
|
(import
|
||||||
src = ./.;
|
(
|
||||||
}).defaultNix
|
let lock = builtins.fromJSON (builtins.readFile ./flake.lock); in
|
||||||
|
fetchTarball {
|
||||||
|
url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
|
||||||
|
sha256 = lock.nodes.flake-compat.locked.narHash;
|
||||||
|
}
|
||||||
|
)
|
||||||
|
{ src = ./.; }
|
||||||
|
).defaultNix
|
||||||
|
|
|
||||||
3
doc/internal-api/.gitignore
vendored
Normal file
3
doc/internal-api/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
/doxygen.cfg
|
||||||
|
/html
|
||||||
|
/latex
|
||||||
63
doc/internal-api/doxygen.cfg.in
Normal file
63
doc/internal-api/doxygen.cfg.in
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
# Doxyfile 1.9.5
|
||||||
|
|
||||||
|
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
||||||
|
# double-quotes, unless you are using Doxywizard) that should identify the
|
||||||
|
# project for which the documentation is generated. This name is used in the
|
||||||
|
# title of most generated pages and in a few other places.
|
||||||
|
# The default value is: My Project.
|
||||||
|
|
||||||
|
PROJECT_NAME = "Nix"
|
||||||
|
|
||||||
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
||||||
|
# could be handy for archiving the generated documentation or if some version
|
||||||
|
# control system is used.
|
||||||
|
|
||||||
|
PROJECT_NUMBER = @PACKAGE_VERSION@
|
||||||
|
|
||||||
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
|
# quick idea about the purpose of the project. Keep the description short.
|
||||||
|
|
||||||
|
PROJECT_BRIEF = "Nix, the purely functional package manager; unstable internal interfaces"
|
||||||
|
|
||||||
|
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
|
||||||
|
# The default value is: YES.
|
||||||
|
|
||||||
|
GENERATE_LATEX = NO
|
||||||
|
|
||||||
|
# The INPUT tag is used to specify the files and/or directories that contain
|
||||||
|
# documented source files. You may enter file names like myfile.cpp or
|
||||||
|
# directories like /usr/src/myproject. Separate the files or directories with
|
||||||
|
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||||
|
# Note: If this tag is empty the current directory is searched.
|
||||||
|
|
||||||
|
# FIXME Make this list more maintainable somehow. We could maybe generate this
|
||||||
|
# in the Makefile, but we would need to change how `.in` files are preprocessed
|
||||||
|
# so they can expand variables despite configure variables.
|
||||||
|
|
||||||
|
INPUT = \
|
||||||
|
src/libcmd \
|
||||||
|
src/libexpr \
|
||||||
|
src/libexpr/flake \
|
||||||
|
src/libexpr/tests \
|
||||||
|
src/libexpr/tests/value \
|
||||||
|
src/libexpr/value \
|
||||||
|
src/libfetchers \
|
||||||
|
src/libmain \
|
||||||
|
src/libstore \
|
||||||
|
src/libstore/build \
|
||||||
|
src/libstore/builtins \
|
||||||
|
src/libstore/tests \
|
||||||
|
src/libutil \
|
||||||
|
src/libutil/tests \
|
||||||
|
src/nix \
|
||||||
|
src/nix-env \
|
||||||
|
src/nix-store
|
||||||
|
|
||||||
|
# The INCLUDE_PATH tag can be used to specify one or more directories that
|
||||||
|
# contain include files that are not input files but should be processed by the
|
||||||
|
# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
|
||||||
|
# RECURSIVE has no effect here.
|
||||||
|
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
|
||||||
|
|
||||||
|
INCLUDE_PATH = @RAPIDCHECK_HEADERS@
|
||||||
19
doc/internal-api/local.mk
Normal file
19
doc/internal-api/local.mk
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
.PHONY: internal-api-html
|
||||||
|
|
||||||
|
ifeq ($(internal_api_docs), yes)
|
||||||
|
|
||||||
|
$(docdir)/internal-api/html/index.html $(docdir)/internal-api/latex: $(d)/doxygen.cfg
|
||||||
|
mkdir -p $(docdir)/internal-api
|
||||||
|
{ cat $< ; echo "OUTPUT_DIRECTORY=$(docdir)/internal-api" ; } | doxygen -
|
||||||
|
|
||||||
|
# Generate the HTML API docs for Nix's unstable internal interfaces.
|
||||||
|
internal-api-html: $(docdir)/internal-api/html/index.html
|
||||||
|
|
||||||
|
else
|
||||||
|
|
||||||
|
# Make a nicer error message
|
||||||
|
internal-api-html:
|
||||||
|
@echo "Internal API docs are disabled. Configure with '--enable-internal-api-docs', or avoid calling 'make internal-api-html'."
|
||||||
|
@exit 1
|
||||||
|
|
||||||
|
endif
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
{ toplevel }:
|
cliDumpStr:
|
||||||
|
|
||||||
with builtins;
|
with builtins;
|
||||||
with import ./utils.nix;
|
with import ./utils.nix;
|
||||||
|
|
@ -7,6 +7,7 @@ let
|
||||||
|
|
||||||
showCommand = { command, details, filename, toplevel }:
|
showCommand = { command, details, filename, toplevel }:
|
||||||
let
|
let
|
||||||
|
|
||||||
result = ''
|
result = ''
|
||||||
> **Warning** \
|
> **Warning** \
|
||||||
> This program is **experimental** and its interface is subject to change.
|
> This program is **experimental** and its interface is subject to change.
|
||||||
|
|
@ -25,6 +26,7 @@ let
|
||||||
|
|
||||||
${maybeOptions}
|
${maybeOptions}
|
||||||
'';
|
'';
|
||||||
|
|
||||||
showSynopsis = command: args:
|
showSynopsis = command: args:
|
||||||
let
|
let
|
||||||
showArgument = arg: "*${arg.label}*" + (if arg ? arity then "" else "...");
|
showArgument = arg: "*${arg.label}*" + (if arg ? arity then "" else "...");
|
||||||
|
|
@ -32,6 +34,7 @@ let
|
||||||
in ''
|
in ''
|
||||||
`${command}` [*option*...] ${arguments}
|
`${command}` [*option*...] ${arguments}
|
||||||
'';
|
'';
|
||||||
|
|
||||||
maybeSubcommands = if details ? commands && details.commands != {}
|
maybeSubcommands = if details ? commands && details.commands != {}
|
||||||
then ''
|
then ''
|
||||||
where *subcommand* is one of the following:
|
where *subcommand* is one of the following:
|
||||||
|
|
@ -39,26 +42,38 @@ let
|
||||||
${subcommands}
|
${subcommands}
|
||||||
''
|
''
|
||||||
else "";
|
else "";
|
||||||
|
|
||||||
subcommands = if length categories > 1
|
subcommands = if length categories > 1
|
||||||
then listCategories
|
then listCategories
|
||||||
else listSubcommands details.commands;
|
else listSubcommands details.commands;
|
||||||
|
|
||||||
categories = sort (x: y: x.id < y.id) (unique (map (cmd: cmd.category) (attrValues details.commands)));
|
categories = sort (x: y: x.id < y.id) (unique (map (cmd: cmd.category) (attrValues details.commands)));
|
||||||
|
|
||||||
listCategories = concatStrings (map showCategory categories);
|
listCategories = concatStrings (map showCategory categories);
|
||||||
|
|
||||||
showCategory = cat: ''
|
showCategory = cat: ''
|
||||||
**${toString cat.description}:**
|
**${toString cat.description}:**
|
||||||
|
|
||||||
${listSubcommands (filterAttrs (n: v: v.category == cat) details.commands)}
|
${listSubcommands (filterAttrs (n: v: v.category == cat) details.commands)}
|
||||||
'';
|
'';
|
||||||
|
|
||||||
listSubcommands = cmds: concatStrings (attrValues (mapAttrs showSubcommand cmds));
|
listSubcommands = cmds: concatStrings (attrValues (mapAttrs showSubcommand cmds));
|
||||||
|
|
||||||
showSubcommand = name: subcmd: ''
|
showSubcommand = name: subcmd: ''
|
||||||
* [`${command} ${name}`](./${appendName filename name}.md) - ${subcmd.description}
|
* [`${command} ${name}`](./${appendName filename name}.md) - ${subcmd.description}
|
||||||
'';
|
'';
|
||||||
maybeDocumentation = if details ? doc then details.doc else "";
|
|
||||||
|
maybeDocumentation =
|
||||||
|
if details ? doc
|
||||||
|
then replaceStrings ["@stores@"] [storeDocs] details.doc
|
||||||
|
else "";
|
||||||
|
|
||||||
maybeOptions = if details.flags == {} then "" else ''
|
maybeOptions = if details.flags == {} then "" else ''
|
||||||
# Options
|
# Options
|
||||||
|
|
||||||
${showOptions details.flags toplevel.flags}
|
${showOptions details.flags toplevel.flags}
|
||||||
'';
|
'';
|
||||||
|
|
||||||
showOptions = options: commonOptions:
|
showOptions = options: commonOptions:
|
||||||
let
|
let
|
||||||
allOptions = options // commonOptions;
|
allOptions = options // commonOptions;
|
||||||
|
|
@ -98,13 +113,13 @@ let
|
||||||
};
|
};
|
||||||
in [ cmd ] ++ concatMap subcommand (attrNames details.commands or {});
|
in [ cmd ] ++ concatMap subcommand (attrNames details.commands or {});
|
||||||
|
|
||||||
parsedToplevel = builtins.fromJSON toplevel;
|
cliDump = builtins.fromJSON cliDumpStr;
|
||||||
|
|
||||||
manpages = processCommand {
|
manpages = processCommand {
|
||||||
command = "nix";
|
command = "nix";
|
||||||
details = parsedToplevel;
|
details = cliDump.args;
|
||||||
filename = "nix";
|
filename = "nix";
|
||||||
toplevel = parsedToplevel;
|
toplevel = cliDump.args;
|
||||||
};
|
};
|
||||||
|
|
||||||
tableOfContents = let
|
tableOfContents = let
|
||||||
|
|
@ -112,4 +127,18 @@ let
|
||||||
" - [${page.command}](command-ref/new-cli/${page.name})";
|
" - [${page.command}](command-ref/new-cli/${page.name})";
|
||||||
in concatStringsSep "\n" (map showEntry manpages) + "\n";
|
in concatStringsSep "\n" (map showEntry manpages) + "\n";
|
||||||
|
|
||||||
|
storeDocs =
|
||||||
|
let
|
||||||
|
showStore = name: { settings, doc }:
|
||||||
|
''
|
||||||
|
## ${name}
|
||||||
|
|
||||||
|
${doc}
|
||||||
|
|
||||||
|
**Settings**:
|
||||||
|
|
||||||
|
${showSettings { useAnchors = false; } settings}
|
||||||
|
'';
|
||||||
|
in concatStrings (attrValues (mapAttrs showStore cliDump.stores));
|
||||||
|
|
||||||
in (listToAttrs manpages) // { "SUMMARY.md" = tableOfContents; }
|
in (listToAttrs manpages) // { "SUMMARY.md" = tableOfContents; }
|
||||||
|
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
let
|
|
||||||
inherit (builtins) attrNames concatStringsSep isAttrs isBool;
|
|
||||||
inherit (import ./utils.nix) concatStrings squash splitLines;
|
|
||||||
in
|
|
||||||
|
|
||||||
optionsInfo:
|
|
||||||
let
|
|
||||||
showOption = name:
|
|
||||||
let
|
|
||||||
inherit (optionsInfo.${name}) description documentDefault defaultValue aliases;
|
|
||||||
result = squash ''
|
|
||||||
- <span id="conf-${name}">[`${name}`](#conf-${name})</span>
|
|
||||||
|
|
||||||
${indent " " body}
|
|
||||||
'';
|
|
||||||
# separate body to cleanly handle indentation
|
|
||||||
body = ''
|
|
||||||
${description}
|
|
||||||
|
|
||||||
**Default:** ${showDefault documentDefault defaultValue}
|
|
||||||
|
|
||||||
${showAliases aliases}
|
|
||||||
'';
|
|
||||||
showDefault = documentDefault: defaultValue:
|
|
||||||
if documentDefault then
|
|
||||||
# a StringMap value type is specified as a string, but
|
|
||||||
# this shows the value type. The empty stringmap is `null` in
|
|
||||||
# JSON, but that converts to `{ }` here.
|
|
||||||
if defaultValue == "" || defaultValue == [] || isAttrs defaultValue
|
|
||||||
then "*empty*"
|
|
||||||
else if isBool defaultValue then
|
|
||||||
if defaultValue then "`true`" else "`false`"
|
|
||||||
else "`${toString defaultValue}`"
|
|
||||||
else "*machine-specific*";
|
|
||||||
showAliases = aliases:
|
|
||||||
if aliases == [] then "" else
|
|
||||||
"**Deprecated alias:** ${(concatStringsSep ", " (map (s: "`${s}`") aliases))}";
|
|
||||||
indent = prefix: s:
|
|
||||||
concatStringsSep "\n" (map (x: if x == "" then x else "${prefix}${x}") (splitLines s));
|
|
||||||
in result;
|
|
||||||
in concatStrings (map showOption (attrNames optionsInfo))
|
|
||||||
|
|
@ -1,17 +1,24 @@
|
||||||
ifeq ($(doc_generate),yes)
|
ifeq ($(doc_generate),yes)
|
||||||
|
|
||||||
MANUAL_SRCS := \
|
MANUAL_SRCS := \
|
||||||
$(call rwildcard, $(d)/src, *.md) \
|
$(call rwildcard, $(d)/src, *.md) \
|
||||||
$(call rwildcard, $(d)/src, */*.md)
|
$(call rwildcard, $(d)/src, */*.md)
|
||||||
|
|
||||||
# Generate man pages.
|
|
||||||
man-pages := $(foreach n, \
|
man-pages := $(foreach n, \
|
||||||
nix-env.1 nix-build.1 nix-shell.1 nix-store.1 nix-instantiate.1 \
|
nix-env.1 nix-store.1 \
|
||||||
nix-collect-garbage.1 \
|
nix-build.1 nix-shell.1 nix-instantiate.1 \
|
||||||
nix-prefetch-url.1 nix-channel.1 \
|
nix-collect-garbage.1 \
|
||||||
nix-hash.1 nix-copy-closure.1 \
|
nix-prefetch-url.1 nix-channel.1 \
|
||||||
nix.conf.5 nix-daemon.8, \
|
nix-hash.1 nix-copy-closure.1 \
|
||||||
$(d)/$(n))
|
nix.conf.5 nix-daemon.8 \
|
||||||
|
, $(d)/$(n))
|
||||||
|
|
||||||
|
# man pages for subcommands
|
||||||
|
# convert from `$(d)/src/command-ref/nix-{1}/{2}.md` to `$(d)/nix-{1}-{2}.1`
|
||||||
|
# FIXME: unify with how nix3-cli man pages are generated
|
||||||
|
man-pages += $(foreach subcommand, \
|
||||||
|
$(filter-out %opt-common.md %env-common.md, $(wildcard $(d)/src/command-ref/nix-*/*.md)), \
|
||||||
|
$(d)/$(subst /,-,$(subst $(d)/src/command-ref/,,$(subst .md,.1,$(subcommand)))))
|
||||||
|
|
||||||
clean-files += $(d)/*.1 $(d)/*.5 $(d)/*.8
|
clean-files += $(d)/*.1 $(d)/*.5 $(d)/*.8
|
||||||
|
|
||||||
|
|
@ -26,9 +33,42 @@ dummy-env = env -i \
|
||||||
|
|
||||||
nix-eval = $(dummy-env) $(bindir)/nix eval --experimental-features nix-command -I nix/corepkgs=corepkgs --store dummy:// --impure --raw
|
nix-eval = $(dummy-env) $(bindir)/nix eval --experimental-features nix-command -I nix/corepkgs=corepkgs --store dummy:// --impure --raw
|
||||||
|
|
||||||
|
# re-implement mdBook's include directive to make it usable for terminal output and for proper @docroot@ substitution
|
||||||
|
define process-includes
|
||||||
|
while read -r line; do \
|
||||||
|
set -euo pipefail; \
|
||||||
|
filename="$$(dirname $(1))/$$(sed 's/{{#include \(.*\)}}/\1/'<<< $$line)"; \
|
||||||
|
test -f "$$filename" || ( echo "#include-d file '$$filename' does not exist." >&2; exit 1; ); \
|
||||||
|
matchline="$$(sed 's|/|\\/|g' <<< $$line)"; \
|
||||||
|
sed -i "/$$matchline/r $$filename" $(2); \
|
||||||
|
sed -i "s/$$matchline//" $(2); \
|
||||||
|
done < <(grep '{{#include' $(1))
|
||||||
|
endef
|
||||||
|
|
||||||
|
$(d)/nix-env-%.1: $(d)/src/command-ref/nix-env/%.md
|
||||||
|
@printf "Title: %s\n\n" "$(subst nix-env-,nix-env --,$$(basename "$@" .1))" > $^.tmp
|
||||||
|
$(render-subcommand)
|
||||||
|
|
||||||
|
$(d)/nix-store-%.1: $(d)/src/command-ref/nix-store/%.md
|
||||||
|
@printf -- 'Title: %s\n\n' "$(subst nix-store-,nix-store --,$$(basename "$@" .1))" > $^.tmp
|
||||||
|
$(render-subcommand)
|
||||||
|
|
||||||
|
# FIXME: there surely is some more deduplication to be achieved here with even darker Make magic
|
||||||
|
define render-subcommand
|
||||||
|
@cat $^ >> $^.tmp
|
||||||
|
@$(call process-includes,$^,$^.tmp)
|
||||||
|
$(trace-gen) lowdown -sT man --nroff-nolinks -M section=1 $^.tmp -o $@
|
||||||
|
@# fix up `lowdown`'s automatic escaping of `--`
|
||||||
|
@# https://github.com/kristapsdz/lowdown/blob/edca6ce6d5336efb147321a43c47a698de41bb7c/entity.c#L202
|
||||||
|
@sed -i 's/\e\[u2013\]/--/' $@
|
||||||
|
@rm $^.tmp
|
||||||
|
endef
|
||||||
|
|
||||||
|
|
||||||
$(d)/%.1: $(d)/src/command-ref/%.md
|
$(d)/%.1: $(d)/src/command-ref/%.md
|
||||||
@printf "Title: %s\n\n" "$$(basename $@ .1)" > $^.tmp
|
@printf "Title: %s\n\n" "$$(basename $@ .1)" > $^.tmp
|
||||||
@cat $^ >> $^.tmp
|
@cat $^ >> $^.tmp
|
||||||
|
@$(call process-includes,$^,$^.tmp)
|
||||||
$(trace-gen) lowdown -sT man --nroff-nolinks -M section=1 $^.tmp -o $@
|
$(trace-gen) lowdown -sT man --nroff-nolinks -M section=1 $^.tmp -o $@
|
||||||
@rm $^.tmp
|
@rm $^.tmp
|
||||||
|
|
||||||
|
|
@ -45,25 +85,21 @@ $(d)/nix.conf.5: $(d)/src/command-ref/conf-file.md
|
||||||
@rm $^.tmp
|
@rm $^.tmp
|
||||||
|
|
||||||
$(d)/src/SUMMARY.md: $(d)/src/SUMMARY.md.in $(d)/src/command-ref/new-cli
|
$(d)/src/SUMMARY.md: $(d)/src/SUMMARY.md.in $(d)/src/command-ref/new-cli
|
||||||
$(trace-gen) cat doc/manual/src/SUMMARY.md.in | while IFS= read line; do if [[ $$line = @manpages@ ]]; then cat doc/manual/src/command-ref/new-cli/SUMMARY.md; else echo "$$line"; fi; done > $@.tmp
|
@cp $< $@
|
||||||
@mv $@.tmp $@
|
@$(call process-includes,$@,$@)
|
||||||
|
|
||||||
$(d)/src/command-ref/new-cli: $(d)/nix.json $(d)/generate-manpage.nix $(bindir)/nix
|
$(d)/src/command-ref/new-cli: $(d)/nix.json $(d)/generate-manpage.nix $(bindir)/nix
|
||||||
@rm -rf $@
|
@rm -rf $@ $@.tmp
|
||||||
$(trace-gen) $(nix-eval) --write-to $@.tmp --expr 'import doc/manual/generate-manpage.nix { toplevel = builtins.readFile $<; }'
|
$(trace-gen) $(nix-eval) --write-to $@.tmp --expr 'import doc/manual/generate-manpage.nix (builtins.readFile $<)'
|
||||||
@# @docroot@: https://nixos.org/manual/nix/unstable/contributing/hacking.html#docroot-variable
|
|
||||||
$(trace-gen) sed -i $@.tmp/*.md -e 's^@docroot@^../..^g'
|
|
||||||
@mv $@.tmp $@
|
@mv $@.tmp $@
|
||||||
|
|
||||||
$(d)/src/command-ref/conf-file.md: $(d)/conf-file.json $(d)/generate-options.nix $(d)/src/command-ref/conf-file-prefix.md $(bindir)/nix
|
$(d)/src/command-ref/conf-file.md: $(d)/conf-file.json $(d)/utils.nix $(d)/src/command-ref/conf-file-prefix.md $(bindir)/nix
|
||||||
@cat doc/manual/src/command-ref/conf-file-prefix.md > $@.tmp
|
@cat doc/manual/src/command-ref/conf-file-prefix.md > $@.tmp
|
||||||
@# @docroot@: https://nixos.org/manual/nix/unstable/contributing/hacking.html#docroot-variable
|
$(trace-gen) $(nix-eval) --expr '(import doc/manual/utils.nix).showSettings { useAnchors = true; } (builtins.fromJSON (builtins.readFile $<))' >> $@.tmp;
|
||||||
$(trace-gen) $(nix-eval) --expr 'import doc/manual/generate-options.nix (builtins.fromJSON (builtins.readFile $<))' \
|
|
||||||
| sed -e 's^@docroot@^..^g'>> $@.tmp
|
|
||||||
@mv $@.tmp $@
|
@mv $@.tmp $@
|
||||||
|
|
||||||
$(d)/nix.json: $(bindir)/nix
|
$(d)/nix.json: $(bindir)/nix
|
||||||
$(trace-gen) $(dummy-env) $(bindir)/nix __dump-args > $@.tmp
|
$(trace-gen) $(dummy-env) $(bindir)/nix __dump-cli > $@.tmp
|
||||||
@mv $@.tmp $@
|
@mv $@.tmp $@
|
||||||
|
|
||||||
$(d)/conf-file.json: $(bindir)/nix
|
$(d)/conf-file.json: $(bindir)/nix
|
||||||
|
|
@ -72,9 +108,7 @@ $(d)/conf-file.json: $(bindir)/nix
|
||||||
|
|
||||||
$(d)/src/language/builtins.md: $(d)/builtins.json $(d)/generate-builtins.nix $(d)/src/language/builtins-prefix.md $(bindir)/nix
|
$(d)/src/language/builtins.md: $(d)/builtins.json $(d)/generate-builtins.nix $(d)/src/language/builtins-prefix.md $(bindir)/nix
|
||||||
@cat doc/manual/src/language/builtins-prefix.md > $@.tmp
|
@cat doc/manual/src/language/builtins-prefix.md > $@.tmp
|
||||||
@# @docroot@: https://nixos.org/manual/nix/unstable/contributing/hacking.html#docroot-variable
|
$(trace-gen) $(nix-eval) --expr 'import doc/manual/generate-builtins.nix (builtins.fromJSON (builtins.readFile $<))' >> $@.tmp;
|
||||||
$(trace-gen) $(nix-eval) --expr 'import doc/manual/generate-builtins.nix (builtins.fromJSON (builtins.readFile $<))' \
|
|
||||||
| sed -e 's^@docroot@^..^g' >> $@.tmp
|
|
||||||
@cat doc/manual/src/language/builtins-suffix.md >> $@.tmp
|
@cat doc/manual/src/language/builtins-suffix.md >> $@.tmp
|
||||||
@mv $@.tmp $@
|
@mv $@.tmp $@
|
||||||
|
|
||||||
|
|
@ -83,7 +117,8 @@ $(d)/builtins.json: $(bindir)/nix
|
||||||
@mv $@.tmp $@
|
@mv $@.tmp $@
|
||||||
|
|
||||||
# Generate the HTML manual.
|
# Generate the HTML manual.
|
||||||
html: $(docdir)/manual/index.html
|
.PHONY: manual-html
|
||||||
|
manual-html: $(docdir)/manual/index.html
|
||||||
install: $(docdir)/manual/index.html
|
install: $(docdir)/manual/index.html
|
||||||
|
|
||||||
# Generate 'nix' manpages.
|
# Generate 'nix' manpages.
|
||||||
|
|
@ -91,6 +126,8 @@ install: $(mandir)/man1/nix3-manpages
|
||||||
man: doc/manual/generated/man1/nix3-manpages
|
man: doc/manual/generated/man1/nix3-manpages
|
||||||
all: doc/manual/generated/man1/nix3-manpages
|
all: doc/manual/generated/man1/nix3-manpages
|
||||||
|
|
||||||
|
# FIXME: unify with how the other man pages are generated.
|
||||||
|
# this one works differently and does not use any of the amenities provided by `/mk/lib.mk`.
|
||||||
$(mandir)/man1/nix3-manpages: doc/manual/generated/man1/nix3-manpages
|
$(mandir)/man1/nix3-manpages: doc/manual/generated/man1/nix3-manpages
|
||||||
@mkdir -p $(DESTDIR)$$(dirname $@)
|
@mkdir -p $(DESTDIR)$$(dirname $@)
|
||||||
$(trace-install) install -m 0644 $$(dirname $<)/* $(DESTDIR)$$(dirname $@)
|
$(trace-install) install -m 0644 $$(dirname $<)/* $(DESTDIR)$$(dirname $@)
|
||||||
|
|
@ -98,21 +135,31 @@ $(mandir)/man1/nix3-manpages: doc/manual/generated/man1/nix3-manpages
|
||||||
doc/manual/generated/man1/nix3-manpages: $(d)/src/command-ref/new-cli
|
doc/manual/generated/man1/nix3-manpages: $(d)/src/command-ref/new-cli
|
||||||
@mkdir -p $(DESTDIR)$$(dirname $@)
|
@mkdir -p $(DESTDIR)$$(dirname $@)
|
||||||
$(trace-gen) for i in doc/manual/src/command-ref/new-cli/*.md; do \
|
$(trace-gen) for i in doc/manual/src/command-ref/new-cli/*.md; do \
|
||||||
name=$$(basename $$i .md); \
|
name=$$(basename $$i .md); \
|
||||||
tmpFile=$$(mktemp); \
|
tmpFile=$$(mktemp); \
|
||||||
if [[ $$name = SUMMARY ]]; then continue; fi; \
|
if [[ $$name = SUMMARY ]]; then continue; fi; \
|
||||||
printf "Title: %s\n\n" "$$name" > $$tmpFile; \
|
printf "Title: %s\n\n" "$$name" > $$tmpFile; \
|
||||||
cat $$i >> $$tmpFile; \
|
cat $$i >> $$tmpFile; \
|
||||||
lowdown -sT man --nroff-nolinks -M section=1 $$tmpFile -o $(DESTDIR)$$(dirname $@)/$$name.1; \
|
lowdown -sT man --nroff-nolinks -M section=1 $$tmpFile -o $(DESTDIR)$$(dirname $@)/$$name.1; \
|
||||||
rm $$tmpFile; \
|
rm $$tmpFile; \
|
||||||
done
|
done
|
||||||
@touch $@
|
@touch $@
|
||||||
|
|
||||||
$(docdir)/manual/index.html: $(MANUAL_SRCS) $(d)/book.toml $(d)/anchors.jq $(d)/custom.css $(d)/src/SUMMARY.md $(d)/src/command-ref/new-cli $(d)/src/command-ref/conf-file.md $(d)/src/language/builtins.md
|
$(docdir)/manual/index.html: $(MANUAL_SRCS) $(d)/book.toml $(d)/anchors.jq $(d)/custom.css $(d)/src/SUMMARY.md $(d)/src/command-ref/new-cli $(d)/src/command-ref/conf-file.md $(d)/src/language/builtins.md
|
||||||
$(trace-gen) \
|
$(trace-gen) \
|
||||||
set -euo pipefail; \
|
tmp="$$(mktemp -d)"; \
|
||||||
RUST_LOG=warn mdbook build doc/manual -d $(DESTDIR)$(docdir)/manual.tmp 2>&1 \
|
cp -r doc/manual "$$tmp"; \
|
||||||
| { grep -Fv "because fragment resolution isn't implemented" || :; }
|
find "$$tmp" -name '*.md' | while read -r file; do \
|
||||||
|
$(call process-includes,$$file,$$file); \
|
||||||
|
done; \
|
||||||
|
find "$$tmp" -name '*.md' | while read -r file; do \
|
||||||
|
docroot="$$(realpath --relative-to="$$(dirname "$$file")" $$tmp/manual/src)"; \
|
||||||
|
sed -i "s,@docroot@,$$docroot,g" "$$file"; \
|
||||||
|
done; \
|
||||||
|
set -euo pipefail; \
|
||||||
|
RUST_LOG=warn mdbook build "$$tmp/manual" -d $(DESTDIR)$(docdir)/manual.tmp 2>&1 \
|
||||||
|
| { grep -Fv "because fragment resolution isn't implemented" || :; }; \
|
||||||
|
rm -rf "$$tmp/manual"
|
||||||
@rm -rf $(DESTDIR)$(docdir)/manual
|
@rm -rf $(DESTDIR)$(docdir)/manual
|
||||||
@mv $(DESTDIR)$(docdir)/manual.tmp/html $(DESTDIR)$(docdir)/manual
|
@mv $(DESTDIR)$(docdir)/manual.tmp/html $(DESTDIR)$(docdir)/manual
|
||||||
@rm -rf $(DESTDIR)$(docdir)/manual.tmp
|
@rm -rf $(DESTDIR)$(docdir)/manual.tmp
|
||||||
|
|
|
||||||
|
|
@ -44,10 +44,41 @@
|
||||||
- [Common Options](command-ref/opt-common.md)
|
- [Common Options](command-ref/opt-common.md)
|
||||||
- [Common Environment Variables](command-ref/env-common.md)
|
- [Common Environment Variables](command-ref/env-common.md)
|
||||||
- [Main Commands](command-ref/main-commands.md)
|
- [Main Commands](command-ref/main-commands.md)
|
||||||
- [nix-env](command-ref/nix-env.md)
|
|
||||||
- [nix-build](command-ref/nix-build.md)
|
- [nix-build](command-ref/nix-build.md)
|
||||||
- [nix-shell](command-ref/nix-shell.md)
|
- [nix-shell](command-ref/nix-shell.md)
|
||||||
- [nix-store](command-ref/nix-store.md)
|
- [nix-store](command-ref/nix-store.md)
|
||||||
|
- [nix-store --add-fixed](command-ref/nix-store/add-fixed.md)
|
||||||
|
- [nix-store --add](command-ref/nix-store/add.md)
|
||||||
|
- [nix-store --delete](command-ref/nix-store/delete.md)
|
||||||
|
- [nix-store --dump-db](command-ref/nix-store/dump-db.md)
|
||||||
|
- [nix-store --dump](command-ref/nix-store/dump.md)
|
||||||
|
- [nix-store --export](command-ref/nix-store/export.md)
|
||||||
|
- [nix-store --gc](command-ref/nix-store/gc.md)
|
||||||
|
- [nix-store --generate-binary-cache-key](command-ref/nix-store/generate-binary-cache-key.md)
|
||||||
|
- [nix-store --import](command-ref/nix-store/import.md)
|
||||||
|
- [nix-store --load-db](command-ref/nix-store/load-db.md)
|
||||||
|
- [nix-store --optimise](command-ref/nix-store/optimise.md)
|
||||||
|
- [nix-store --print-env](command-ref/nix-store/print-env.md)
|
||||||
|
- [nix-store --query](command-ref/nix-store/query.md)
|
||||||
|
- [nix-store --read-log](command-ref/nix-store/read-log.md)
|
||||||
|
- [nix-store --realise](command-ref/nix-store/realise.md)
|
||||||
|
- [nix-store --repair-path](command-ref/nix-store/repair-path.md)
|
||||||
|
- [nix-store --restore](command-ref/nix-store/restore.md)
|
||||||
|
- [nix-store --serve](command-ref/nix-store/serve.md)
|
||||||
|
- [nix-store --verify-path](command-ref/nix-store/verify-path.md)
|
||||||
|
- [nix-store --verify](command-ref/nix-store/verify.md)
|
||||||
|
- [nix-env](command-ref/nix-env.md)
|
||||||
|
- [nix-env --delete-generations](command-ref/nix-env/delete-generations.md)
|
||||||
|
- [nix-env --install](command-ref/nix-env/install.md)
|
||||||
|
- [nix-env --list-generations](command-ref/nix-env/list-generations.md)
|
||||||
|
- [nix-env --query](command-ref/nix-env/query.md)
|
||||||
|
- [nix-env --rollback](command-ref/nix-env/rollback.md)
|
||||||
|
- [nix-env --set-flag](command-ref/nix-env/set-flag.md)
|
||||||
|
- [nix-env --set](command-ref/nix-env/set.md)
|
||||||
|
- [nix-env --switch-generation](command-ref/nix-env/switch-generation.md)
|
||||||
|
- [nix-env --switch-profile](command-ref/nix-env/switch-profile.md)
|
||||||
|
- [nix-env --uninstall](command-ref/nix-env/uninstall.md)
|
||||||
|
- [nix-env --upgrade](command-ref/nix-env/upgrade.md)
|
||||||
- [Utilities](command-ref/utilities.md)
|
- [Utilities](command-ref/utilities.md)
|
||||||
- [nix-channel](command-ref/nix-channel.md)
|
- [nix-channel](command-ref/nix-channel.md)
|
||||||
- [nix-collect-garbage](command-ref/nix-collect-garbage.md)
|
- [nix-collect-garbage](command-ref/nix-collect-garbage.md)
|
||||||
|
|
@ -57,7 +88,7 @@
|
||||||
- [nix-instantiate](command-ref/nix-instantiate.md)
|
- [nix-instantiate](command-ref/nix-instantiate.md)
|
||||||
- [nix-prefetch-url](command-ref/nix-prefetch-url.md)
|
- [nix-prefetch-url](command-ref/nix-prefetch-url.md)
|
||||||
- [Experimental Commands](command-ref/experimental-commands.md)
|
- [Experimental Commands](command-ref/experimental-commands.md)
|
||||||
@manpages@
|
{{#include ./command-ref/new-cli/SUMMARY.md}}
|
||||||
- [Files](command-ref/files.md)
|
- [Files](command-ref/files.md)
|
||||||
- [nix.conf](command-ref/conf-file.md)
|
- [nix.conf](command-ref/conf-file.md)
|
||||||
- [Architecture](architecture/architecture.md)
|
- [Architecture](architecture/architecture.md)
|
||||||
|
|
|
||||||
|
|
@ -2,18 +2,29 @@
|
||||||
|
|
||||||
Most Nix commands interpret the following environment variables:
|
Most Nix commands interpret the following environment variables:
|
||||||
|
|
||||||
- [`IN_NIX_SHELL`]{#env-IN_NIX_SHELL}\
|
- <span id="env-IN_NIX_SHELL">[`IN_NIX_SHELL`](#env-IN_NIX_SHELL)</span>\
|
||||||
Indicator that tells if the current environment was set up by
|
Indicator that tells if the current environment was set up by
|
||||||
`nix-shell`. It can have the values `pure` or `impure`.
|
`nix-shell`. It can have the values `pure` or `impure`.
|
||||||
|
|
||||||
- [`NIX_PATH`]{#env-NIX_PATH}\
|
- <span id="env-NIX_PATH">[`NIX_PATH`](#env-NIX_PATH)</span>\
|
||||||
A colon-separated list of directories used to look up the location of Nix
|
A colon-separated list of directories used to look up the location of Nix
|
||||||
expressions using [paths](../language/values.md#type-path)
|
expressions using [paths](@docroot@/language/values.md#type-path)
|
||||||
enclosed in angle brackets (i.e., `<path>`),
|
enclosed in angle brackets (i.e., `<path>`),
|
||||||
e.g. `/home/eelco/Dev:/etc/nixos`. It can be extended using the
|
e.g. `/home/eelco/Dev:/etc/nixos`. It can be extended using the
|
||||||
[`-I` option](./opt-common.md#opt-I).
|
[`-I` option](@docroot@/command-ref/opt-common.md#opt-I).
|
||||||
|
|
||||||
- [`NIX_IGNORE_SYMLINK_STORE`]{#env-NIX_IGNORE_SYMLINK_STORE}\
|
If `NIX_PATH` is not set at all, Nix will fall back to the following list in [impure](@docroot@/command-ref/conf-file.md#conf-pure-eval) and [unrestricted](@docroot@/command-ref/conf-file.md#conf-restrict-eval) evaluation mode:
|
||||||
|
|
||||||
|
1. `$HOME/.nix-defexpr/channels`
|
||||||
|
2. `nixpkgs=/nix/var/nix/profiles/per-user/root/channels/nixpkgs`
|
||||||
|
3. `/nix/var/nix/profiles/per-user/root/channels`
|
||||||
|
|
||||||
|
If `NIX_PATH` is set to an empty string, resolving search paths will always fail.
|
||||||
|
For example, attempting to use `<nixpkgs>` will produce:
|
||||||
|
|
||||||
|
error: file 'nixpkgs' was not found in the Nix search path
|
||||||
|
|
||||||
|
- <span id="env-NIX_IGNORE_SYMLINK_STORE">[`NIX_IGNORE_SYMLINK_STORE`](#env-NIX_IGNORE_SYMLINK_STORE)</span>\
|
||||||
Normally, the Nix store directory (typically `/nix/store`) is not
|
Normally, the Nix store directory (typically `/nix/store`) is not
|
||||||
allowed to contain any symlink components. This is to prevent
|
allowed to contain any symlink components. This is to prevent
|
||||||
“impure” builds. Builders sometimes “canonicalise” paths by
|
“impure” builds. Builders sometimes “canonicalise” paths by
|
||||||
|
|
@ -35,58 +46,58 @@ Most Nix commands interpret the following environment variables:
|
||||||
|
|
||||||
Consult the mount 8 manual page for details.
|
Consult the mount 8 manual page for details.
|
||||||
|
|
||||||
- [`NIX_STORE_DIR`]{#env-NIX_STORE_DIR}\
|
- <span id="env-NIX_STORE_DIR">[`NIX_STORE_DIR`](#env-NIX_STORE_DIR)</span>\
|
||||||
Overrides the location of the Nix store (default `prefix/store`).
|
Overrides the location of the Nix store (default `prefix/store`).
|
||||||
|
|
||||||
- [`NIX_DATA_DIR`]{#env-NIX_DATA_DIR}\
|
- <span id="env-NIX_DATA_DIR">[`NIX_DATA_DIR`](#env-NIX_DATA_DIR)</span>\
|
||||||
Overrides the location of the Nix static data directory (default
|
Overrides the location of the Nix static data directory (default
|
||||||
`prefix/share`).
|
`prefix/share`).
|
||||||
|
|
||||||
- [`NIX_LOG_DIR`]{#env-NIX_LOG_DIR}\
|
- <span id="env-NIX_LOG_DIR">[`NIX_LOG_DIR`](#env-NIX_LOG_DIR)</span>\
|
||||||
Overrides the location of the Nix log directory (default
|
Overrides the location of the Nix log directory (default
|
||||||
`prefix/var/log/nix`).
|
`prefix/var/log/nix`).
|
||||||
|
|
||||||
- [`NIX_STATE_DIR`]{#env-NIX_STATE_DIR}\
|
- <span id="env-NIX_STATE_DIR">[`NIX_STATE_DIR`](#env-NIX_STATE_DIR)</span>\
|
||||||
Overrides the location of the Nix state directory (default
|
Overrides the location of the Nix state directory (default
|
||||||
`prefix/var/nix`).
|
`prefix/var/nix`).
|
||||||
|
|
||||||
- [`NIX_CONF_DIR`]{#env-NIX_CONF_DIR}\
|
- <span id="env-NIX_CONF_DIR">[`NIX_CONF_DIR`](#env-NIX_CONF_DIR)</span>\
|
||||||
Overrides the location of the system Nix configuration directory
|
Overrides the location of the system Nix configuration directory
|
||||||
(default `prefix/etc/nix`).
|
(default `prefix/etc/nix`).
|
||||||
|
|
||||||
- [`NIX_CONFIG`]{#env-NIX_CONFIG}\
|
- <span id="env-NIX_CONFIG">[`NIX_CONFIG`](#env-NIX_CONFIG)</span>\
|
||||||
Applies settings from Nix configuration from the environment.
|
Applies settings from Nix configuration from the environment.
|
||||||
The content is treated as if it was read from a Nix configuration file.
|
The content is treated as if it was read from a Nix configuration file.
|
||||||
Settings are separated by the newline character.
|
Settings are separated by the newline character.
|
||||||
|
|
||||||
- [`NIX_USER_CONF_FILES`]{#env-NIX_USER_CONF_FILES}\
|
- <span id="env-NIX_USER_CONF_FILES">[`NIX_USER_CONF_FILES`](#env-NIX_USER_CONF_FILES)</span>\
|
||||||
Overrides the location of the user Nix configuration files to load
|
Overrides the location of the user Nix configuration files to load
|
||||||
from (defaults to the XDG spec locations). The variable is treated
|
from (defaults to the XDG spec locations). The variable is treated
|
||||||
as a list separated by the `:` token.
|
as a list separated by the `:` token.
|
||||||
|
|
||||||
- [`TMPDIR`]{#env-TMPDIR}\
|
- <span id="env-TMPDIR">[`TMPDIR`](#env-TMPDIR)</span>\
|
||||||
Use the specified directory to store temporary files. In particular,
|
Use the specified directory to store temporary files. In particular,
|
||||||
this includes temporary build directories; these can take up
|
this includes temporary build directories; these can take up
|
||||||
substantial amounts of disk space. The default is `/tmp`.
|
substantial amounts of disk space. The default is `/tmp`.
|
||||||
|
|
||||||
- [`NIX_REMOTE`]{#env-NIX_REMOTE}\
|
- <span id="env-NIX_REMOTE">[`NIX_REMOTE`](#env-NIX_REMOTE)</span>\
|
||||||
This variable should be set to `daemon` if you want to use the Nix
|
This variable should be set to `daemon` if you want to use the Nix
|
||||||
daemon to execute Nix operations. This is necessary in [multi-user
|
daemon to execute Nix operations. This is necessary in [multi-user
|
||||||
Nix installations](../installation/multi-user.md). If the Nix
|
Nix installations](@docroot@/installation/multi-user.md). If the Nix
|
||||||
daemon's Unix socket is at some non-standard path, this variable
|
daemon's Unix socket is at some non-standard path, this variable
|
||||||
should be set to `unix://path/to/socket`. Otherwise, it should be
|
should be set to `unix://path/to/socket`. Otherwise, it should be
|
||||||
left unset.
|
left unset.
|
||||||
|
|
||||||
- [`NIX_SHOW_STATS`]{#env-NIX_SHOW_STATS}\
|
- <span id="env-NIX_SHOW_STATS">[`NIX_SHOW_STATS`](#env-NIX_SHOW_STATS)</span>\
|
||||||
If set to `1`, Nix will print some evaluation statistics, such as
|
If set to `1`, Nix will print some evaluation statistics, such as
|
||||||
the number of values allocated.
|
the number of values allocated.
|
||||||
|
|
||||||
- [`NIX_COUNT_CALLS`]{#env-NIX_COUNT_CALLS}\
|
- <span id="env-NIX_COUNT_CALLS">[`NIX_COUNT_CALLS`](#env-NIX_COUNT_CALLS)</span>\
|
||||||
If set to `1`, Nix will print how often functions were called during
|
If set to `1`, Nix will print how often functions were called during
|
||||||
Nix expression evaluation. This is useful for profiling your Nix
|
Nix expression evaluation. This is useful for profiling your Nix
|
||||||
expressions.
|
expressions.
|
||||||
|
|
||||||
- [`GC_INITIAL_HEAP_SIZE`]{#env-GC_INITIAL_HEAP_SIZE}\
|
- <span id="env-GC_INITIAL_HEAP_SIZE">[`GC_INITIAL_HEAP_SIZE`](#env-GC_INITIAL_HEAP_SIZE)</span>\
|
||||||
If Nix has been configured to use the Boehm garbage collector, this
|
If Nix has been configured to use the Boehm garbage collector, this
|
||||||
variable sets the initial size of the heap in bytes. It defaults to
|
variable sets the initial size of the heap in bytes. It defaults to
|
||||||
384 MiB. Setting it to a low value reduces memory consumption, but
|
384 MiB. Setting it to a low value reduces memory consumption, but
|
||||||
|
|
@ -103,4 +114,4 @@ New Nix commands conform to the [XDG Base Directory Specification], and use the
|
||||||
Classic Nix commands can also be made to follow this standard using the [`use-xdg-base-directories`] configuration option.
|
Classic Nix commands can also be made to follow this standard using the [`use-xdg-base-directories`] configuration option.
|
||||||
|
|
||||||
[XDG Base Directory Specification]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
|
[XDG Base Directory Specification]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
|
||||||
[`use-xdg-base-directories`]: ../command-ref/conf-file.md#conf-use-xdg-base-directories
|
[`use-xdg-base-directories`]: @docroot@/command-ref/conf-file.md#conf-use-xdg-base-directories
|
||||||
|
|
@ -38,7 +38,7 @@ directory containing at least a file named `default.nix`.
|
||||||
`nix-build` is essentially a wrapper around
|
`nix-build` is essentially a wrapper around
|
||||||
[`nix-instantiate`](nix-instantiate.md) (to translate a high-level Nix
|
[`nix-instantiate`](nix-instantiate.md) (to translate a high-level Nix
|
||||||
expression to a low-level [store derivation]) and [`nix-store
|
expression to a low-level [store derivation]) and [`nix-store
|
||||||
--realise`](nix-store.md#operation---realise) (to build the store
|
--realise`](@docroot@/command-ref/nix-store/realise.md) (to build the store
|
||||||
derivation).
|
derivation).
|
||||||
|
|
||||||
[store derivation]: ../glossary.md#gloss-store-derivation
|
[store derivation]: ../glossary.md#gloss-store-derivation
|
||||||
|
|
@ -51,9 +51,8 @@ derivation).
|
||||||
|
|
||||||
# Options
|
# Options
|
||||||
|
|
||||||
All options not listed here are passed to `nix-store
|
All options not listed here are passed to `nix-store --realise`,
|
||||||
--realise`, except for `--arg` and `--attr` / `-A` which are passed to
|
except for `--arg` and `--attr` / `-A` which are passed to `nix-instantiate`.
|
||||||
`nix-instantiate`.
|
|
||||||
|
|
||||||
- <span id="opt-no-out-link">[`--no-out-link`](#opt-no-out-link)<span>
|
- <span id="opt-no-out-link">[`--no-out-link`](#opt-no-out-link)<span>
|
||||||
|
|
||||||
|
|
@ -70,7 +69,9 @@ All options not listed here are passed to `nix-store
|
||||||
Change the name of the symlink to the output path created from
|
Change the name of the symlink to the output path created from
|
||||||
`result` to *outlink*.
|
`result` to *outlink*.
|
||||||
|
|
||||||
The following common options are supported:
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -45,6 +45,10 @@ Note that `--add` does not automatically perform an update.
|
||||||
|
|
||||||
The list of subscribed channels is stored in `~/.nix-channels`.
|
The list of subscribed channels is stored in `~/.nix-channels`.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
To subscribe to the Nixpkgs channel and install the GNU Hello package:
|
To subscribe to the Nixpkgs channel and install the GNU Hello package:
|
||||||
|
|
@ -70,7 +74,7 @@ $ nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
|
||||||
|
|
||||||
# Files
|
# Files
|
||||||
|
|
||||||
- `/nix/var/nix/profiles/per-user/username/channels`\
|
- `${XDG_STATE_HOME-$HOME/.local/state}/nix/profiles/channels`\
|
||||||
`nix-channel` uses a `nix-env` profile to keep track of previous
|
`nix-channel` uses a `nix-env` profile to keep track of previous
|
||||||
versions of the subscribed channels. Every time you run `nix-channel
|
versions of the subscribed channels. Every time you run `nix-channel
|
||||||
--update`, a new channel generation (that is, a symlink to the
|
--update`, a new channel generation (that is, a symlink to the
|
||||||
|
|
@ -79,7 +83,7 @@ $ nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
|
||||||
|
|
||||||
- `~/.nix-defexpr/channels`\
|
- `~/.nix-defexpr/channels`\
|
||||||
This is a symlink to
|
This is a symlink to
|
||||||
`/nix/var/nix/profiles/per-user/username/channels`. It ensures that
|
`${XDG_STATE_HOME-$HOME/.local/state}/nix/profiles/channels`. It ensures that
|
||||||
`nix-env` can find your channels. In a multi-user installation, you
|
`nix-env` can find your channels. In a multi-user installation, you
|
||||||
may also have `~/.nix-defexpr/channels_root`, which links to the
|
may also have `~/.nix-defexpr/channels_root`, which links to the
|
||||||
channels of the root user.
|
channels of the root user.
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@
|
||||||
# Description
|
# Description
|
||||||
|
|
||||||
The command `nix-collect-garbage` is mostly an alias of [`nix-store
|
The command `nix-collect-garbage` is mostly an alias of [`nix-store
|
||||||
--gc`](nix-store.md#operation---gc), that is, it deletes all
|
--gc`](@docroot@/command-ref/nix-store/gc.md), that is, it deletes all
|
||||||
unreachable paths in the Nix store to clean up your system. However,
|
unreachable paths in the Nix store to clean up your system. However,
|
||||||
it provides two additional options: `-d` (`--delete-old`), which
|
it provides two additional options: `-d` (`--delete-old`), which
|
||||||
deletes all old generations of all profiles in `/nix/var/nix/profiles`
|
deletes all old generations of all profiles in `/nix/var/nix/profiles`
|
||||||
|
|
@ -20,6 +20,10 @@ and `--delete-older-than` *period*, where period is a value such as
|
||||||
of days in all profiles in `/nix/var/nix/profiles` (except for the
|
of days in all profiles in `/nix/var/nix/profiles` (except for the
|
||||||
generations that were active at that point in time).
|
generations that were active at that point in time).
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
# Example
|
# Example
|
||||||
|
|
||||||
To delete from the Nix store everything that is not used by the current
|
To delete from the Nix store everything that is not used by the current
|
||||||
|
|
|
||||||
|
|
@ -63,12 +63,16 @@ authentication, you can avoid typing the passphrase with `ssh-agent`.
|
||||||
- `-v`\
|
- `-v`\
|
||||||
Show verbose output.
|
Show verbose output.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
|
|
||||||
- `NIX_SSHOPTS`\
|
- `NIX_SSHOPTS`\
|
||||||
Additional options to be passed to `ssh` on the command
|
Additional options to be passed to `ssh` on the command
|
||||||
line.
|
line.
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
Copy Firefox with all its dependencies to a remote machine:
|
Copy Firefox with all its dependencies to a remote machine:
|
||||||
|
|
|
||||||
|
|
@ -4,15 +4,14 @@
|
||||||
|
|
||||||
# Synopsis
|
# Synopsis
|
||||||
|
|
||||||
`nix-env`
|
`nix-env` *operation* [*options*] [*arguments…*]
|
||||||
[`--option` *name* *value*]
|
[`--option` *name* *value*]
|
||||||
[`--arg` *name* *value*]
|
[`--arg` *name* *value*]
|
||||||
[`--argstr` *name* *value*]
|
[`--argstr` *name* *value*]
|
||||||
[{`--file` | `-f`} *path*]
|
[{`--file` | `-f`} *path*]
|
||||||
[{`--profile` | `-p`} *path(]
|
[{`--profile` | `-p`} *path*]
|
||||||
[`--system-filter` *system*]
|
[`--system-filter` *system*]
|
||||||
[`--dry-run`]
|
[`--dry-run`]
|
||||||
*operation* [*options…*] [*arguments…*]
|
|
||||||
|
|
||||||
# Description
|
# Description
|
||||||
|
|
||||||
|
|
@ -24,7 +23,29 @@ environments: different users can have different environments, and
|
||||||
individual users can switch between different environments.
|
individual users can switch between different environments.
|
||||||
|
|
||||||
`nix-env` takes exactly one *operation* flag which indicates the
|
`nix-env` takes exactly one *operation* flag which indicates the
|
||||||
subcommand to be performed. These are documented below.
|
subcommand to be performed. The following operations are available:
|
||||||
|
|
||||||
|
- [`--install`](./nix-env/install.md)
|
||||||
|
- [`--upgrade`](./nix-env/upgrade.md)
|
||||||
|
- [`--uninstall`](./nix-env/uninstall.md)
|
||||||
|
- [`--set`](./nix-env/set.md)
|
||||||
|
- [`--set-flag`](./nix-env/set-flag.md)
|
||||||
|
- [`--query`](./nix-env/query.md)
|
||||||
|
- [`--switch-profile`](./nix-env/switch-profile.md)
|
||||||
|
- [`--list-generations`](./nix-env/list-generations.md)
|
||||||
|
- [`--delete-generations`](./nix-env/delete-generations.md)
|
||||||
|
- [`--switch-generation`](./nix-env/switch-generation.md)
|
||||||
|
- [`--rollback`](./nix-env/rollback.md)
|
||||||
|
|
||||||
|
These pages can be viewed offline:
|
||||||
|
|
||||||
|
- `man nix-env-<operation>`.
|
||||||
|
|
||||||
|
Example: `man nix-env-install`
|
||||||
|
|
||||||
|
- `nix-env --help --<operation>`
|
||||||
|
|
||||||
|
Example: `nix-env --help --install`
|
||||||
|
|
||||||
# Selectors
|
# Selectors
|
||||||
|
|
||||||
|
|
@ -60,46 +81,6 @@ match. Here are some examples:
|
||||||
Matches any package name containing the strings `firefox` or
|
Matches any package name containing the strings `firefox` or
|
||||||
`chromium`.
|
`chromium`.
|
||||||
|
|
||||||
# Common options
|
|
||||||
|
|
||||||
This section lists the options that are common to all operations. These
|
|
||||||
options are allowed for every subcommand, though they may not always
|
|
||||||
have an effect.
|
|
||||||
|
|
||||||
- `--file` / `-f` *path*\
|
|
||||||
Specifies the Nix expression (designated below as the *active Nix
|
|
||||||
expression*) used by the `--install`, `--upgrade`, and `--query
|
|
||||||
--available` operations to obtain derivations. The default is
|
|
||||||
`~/.nix-defexpr`.
|
|
||||||
|
|
||||||
If the argument starts with `http://` or `https://`, it is
|
|
||||||
interpreted as the URL of a tarball that will be downloaded and
|
|
||||||
unpacked to a temporary location. The tarball must include a single
|
|
||||||
top-level directory containing at least a file named `default.nix`.
|
|
||||||
|
|
||||||
- `--profile` / `-p` *path*\
|
|
||||||
Specifies the profile to be used by those operations that operate on
|
|
||||||
a profile (designated below as the *active profile*). A profile is a
|
|
||||||
sequence of user environments called *generations*, one of which is
|
|
||||||
the *current generation*.
|
|
||||||
|
|
||||||
- `--dry-run`\
|
|
||||||
For the `--install`, `--upgrade`, `--uninstall`,
|
|
||||||
`--switch-generation`, `--delete-generations` and `--rollback`
|
|
||||||
operations, this flag will cause `nix-env` to print what *would* be
|
|
||||||
done if this flag had not been specified, without actually doing it.
|
|
||||||
|
|
||||||
`--dry-run` also prints out which paths will be
|
|
||||||
[substituted](../glossary.md) (i.e., downloaded) and which paths
|
|
||||||
will be built from source (because no substitute is available).
|
|
||||||
|
|
||||||
- `--system-filter` *system*\
|
|
||||||
By default, operations such as `--query
|
|
||||||
--available` show derivations matching any platform. This option
|
|
||||||
allows you to use derivations for the specified platform *system*.
|
|
||||||
|
|
||||||
<!-- end list -->
|
|
||||||
|
|
||||||
# Files
|
# Files
|
||||||
|
|
||||||
- `~/.nix-defexpr`\
|
- `~/.nix-defexpr`\
|
||||||
|
|
@ -145,750 +126,3 @@ have an effect.
|
||||||
symlink points to `prefix/var/nix/profiles/default`. The `PATH`
|
symlink points to `prefix/var/nix/profiles/default`. The `PATH`
|
||||||
environment variable should include `~/.nix-profile/bin` for the
|
environment variable should include `~/.nix-profile/bin` for the
|
||||||
user environment to be visible to the user.
|
user environment to be visible to the user.
|
||||||
|
|
||||||
# Operation `--install`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` {`--install` | `-i`} *args…*
|
|
||||||
[{`--prebuilt-only` | `-b`}]
|
|
||||||
[{`--attr` | `-A`}]
|
|
||||||
[`--from-expression`] [`-E`]
|
|
||||||
[`--from-profile` *path*]
|
|
||||||
[`--preserve-installed` | `-P`]
|
|
||||||
[`--remove-all` | `-r`]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The install operation creates a new user environment, based on the
|
|
||||||
current generation of the active profile, to which a set of store paths
|
|
||||||
described by *args* is added. The arguments *args* map to store paths in
|
|
||||||
a number of possible ways:
|
|
||||||
|
|
||||||
- By default, *args* is a set of derivation names denoting derivations
|
|
||||||
in the active Nix expression. These are realised, and the resulting
|
|
||||||
output paths are installed. Currently installed derivations with a
|
|
||||||
name equal to the name of a derivation being added are removed
|
|
||||||
unless the option `--preserve-installed` is specified.
|
|
||||||
|
|
||||||
If there are multiple derivations matching a name in *args* that
|
|
||||||
have the same name (e.g., `gcc-3.3.6` and `gcc-4.1.1`), then the
|
|
||||||
derivation with the highest *priority* is used. A derivation can
|
|
||||||
define a priority by declaring the `meta.priority` attribute. This
|
|
||||||
attribute should be a number, with a higher value denoting a lower
|
|
||||||
priority. The default priority is `0`.
|
|
||||||
|
|
||||||
If there are multiple matching derivations with the same priority,
|
|
||||||
then the derivation with the highest version will be installed.
|
|
||||||
|
|
||||||
You can force the installation of multiple derivations with the same
|
|
||||||
name by being specific about the versions. For instance, `nix-env -i
|
|
||||||
gcc-3.3.6 gcc-4.1.1` will install both version of GCC (and will
|
|
||||||
probably cause a user environment conflict\!).
|
|
||||||
|
|
||||||
- If `--attr` (`-A`) is specified, the arguments are *attribute
|
|
||||||
paths* that select attributes from the top-level Nix
|
|
||||||
expression. This is faster than using derivation names and
|
|
||||||
unambiguous. To find out the attribute paths of available
|
|
||||||
packages, use `nix-env -qaP`.
|
|
||||||
|
|
||||||
- If `--from-profile` *path* is given, *args* is a set of names
|
|
||||||
denoting installed store paths in the profile *path*. This is an
|
|
||||||
easy way to copy user environment elements from one profile to
|
|
||||||
another.
|
|
||||||
|
|
||||||
- If `--from-expression` is given, *args* are Nix
|
|
||||||
[functions](../language/constructs.md#functions)
|
|
||||||
that are called with the active Nix expression as their single
|
|
||||||
argument. The derivations returned by those function calls are
|
|
||||||
installed. This allows derivations to be specified in an
|
|
||||||
unambiguous way, which is necessary if there are multiple
|
|
||||||
derivations with the same name.
|
|
||||||
|
|
||||||
- If *args* are [store derivation]s, then these are
|
|
||||||
[realised](nix-store.md#operation---realise), and the resulting output paths
|
|
||||||
are installed.
|
|
||||||
|
|
||||||
[store derivation]: ../glossary.md#gloss-store-derivation
|
|
||||||
|
|
||||||
- If *args* are store paths that are not store derivations, then these
|
|
||||||
are [realised](nix-store.md#operation---realise) and installed.
|
|
||||||
|
|
||||||
- By default all outputs are installed for each derivation. That can
|
|
||||||
be reduced by setting `meta.outputsToInstall`.
|
|
||||||
|
|
||||||
## Flags
|
|
||||||
|
|
||||||
- `--prebuilt-only` / `-b`\
|
|
||||||
Use only derivations for which a substitute is registered, i.e.,
|
|
||||||
there is a pre-built binary available that can be downloaded in lieu
|
|
||||||
of building the derivation. Thus, no packages will be built from
|
|
||||||
source.
|
|
||||||
|
|
||||||
- `--preserve-installed`; `-P`\
|
|
||||||
Do not remove derivations with a name matching one of the
|
|
||||||
derivations being installed. Usually, trying to have two versions of
|
|
||||||
the same package installed in the same generation of a profile will
|
|
||||||
lead to an error in building the generation, due to file name
|
|
||||||
clashes between the two versions. However, this is not the case for
|
|
||||||
all packages.
|
|
||||||
|
|
||||||
- `--remove-all`; `-r`\
|
|
||||||
Remove all previously installed packages first. This is equivalent
|
|
||||||
to running `nix-env -e '.*'` first, except that everything happens
|
|
||||||
in a single transaction.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
To install a package using a specific attribute path from the active Nix expression:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -iA gcc40mips
|
|
||||||
installing `gcc-4.0.2'
|
|
||||||
$ nix-env -iA xorg.xorgserver
|
|
||||||
installing `xorg-server-1.2.0'
|
|
||||||
```
|
|
||||||
|
|
||||||
To install a specific version of `gcc` using the derivation name:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --install gcc-3.3.2
|
|
||||||
installing `gcc-3.3.2'
|
|
||||||
uninstalling `gcc-3.1'
|
|
||||||
```
|
|
||||||
|
|
||||||
Using attribute path for selecting a package is preferred,
|
|
||||||
as it is much faster and there will not be multiple matches.
|
|
||||||
|
|
||||||
Note the previously installed version is removed, since
|
|
||||||
`--preserve-installed` was not specified.
|
|
||||||
|
|
||||||
To install an arbitrary version:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --install gcc
|
|
||||||
installing `gcc-3.3.2'
|
|
||||||
```
|
|
||||||
|
|
||||||
To install all derivations in the Nix expression `foo.nix`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -f ~/foo.nix -i '.*'
|
|
||||||
```
|
|
||||||
|
|
||||||
To copy the store path with symbolic name `gcc` from another profile:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -i --from-profile /nix/var/nix/profiles/foo gcc
|
|
||||||
```
|
|
||||||
|
|
||||||
To install a specific [store derivation] (typically created by
|
|
||||||
`nix-instantiate`):
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -i /nix/store/fibjb1bfbpm5mrsxc4mh2d8n37sxh91i-gcc-3.4.3.drv
|
|
||||||
```
|
|
||||||
|
|
||||||
To install a specific output path:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -i /nix/store/y3cgx0xj1p4iv9x0pnnmdhr8iyg741vk-gcc-3.4.3
|
|
||||||
```
|
|
||||||
|
|
||||||
To install from a Nix expression specified on the command-line:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -f ./foo.nix -i -E \
|
|
||||||
'f: (f {system = "i686-linux";}).subversionWithJava'
|
|
||||||
```
|
|
||||||
|
|
||||||
I.e., this evaluates to `(f: (f {system =
|
|
||||||
"i686-linux";}).subversionWithJava) (import ./foo.nix)`, thus selecting
|
|
||||||
the `subversionWithJava` attribute from the set returned by calling the
|
|
||||||
function defined in `./foo.nix`.
|
|
||||||
|
|
||||||
A dry-run tells you which paths will be downloaded or built from source:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -f '<nixpkgs>' -iA hello --dry-run
|
|
||||||
(dry run; not doing anything)
|
|
||||||
installing ‘hello-2.10’
|
|
||||||
this path will be fetched (0.04 MiB download, 0.19 MiB unpacked):
|
|
||||||
/nix/store/wkhdf9jinag5750mqlax6z2zbwhqb76n-hello-2.10
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
To install Firefox from the latest revision in the Nixpkgs/NixOS 14.12
|
|
||||||
channel:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -f https://github.com/NixOS/nixpkgs/archive/nixos-14.12.tar.gz -iA firefox
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--upgrade`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` {`--upgrade` | `-u`} *args*
|
|
||||||
[`--lt` | `--leq` | `--eq` | `--always`]
|
|
||||||
[{`--prebuilt-only` | `-b`}]
|
|
||||||
[{`--attr` | `-A`}]
|
|
||||||
[`--from-expression`] [`-E`]
|
|
||||||
[`--from-profile` *path*]
|
|
||||||
[`--preserve-installed` | `-P`]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The upgrade operation creates a new user environment, based on the
|
|
||||||
current generation of the active profile, in which all store paths are
|
|
||||||
replaced for which there are newer versions in the set of paths
|
|
||||||
described by *args*. Paths for which there are no newer versions are
|
|
||||||
left untouched; this is not an error. It is also not an error if an
|
|
||||||
element of *args* matches no installed derivations.
|
|
||||||
|
|
||||||
For a description of how *args* is mapped to a set of store paths, see
|
|
||||||
[`--install`](#operation---install). If *args* describes multiple
|
|
||||||
store paths with the same symbolic name, only the one with the highest
|
|
||||||
version is installed.
|
|
||||||
|
|
||||||
## Flags
|
|
||||||
|
|
||||||
- `--lt`\
|
|
||||||
Only upgrade a derivation to newer versions. This is the default.
|
|
||||||
|
|
||||||
- `--leq`\
|
|
||||||
In addition to upgrading to newer versions, also “upgrade” to
|
|
||||||
derivations that have the same version. Version are not a unique
|
|
||||||
identification of a derivation, so there may be many derivations
|
|
||||||
that have the same version. This flag may be useful to force
|
|
||||||
“synchronisation” between the installed and available derivations.
|
|
||||||
|
|
||||||
- `--eq`\
|
|
||||||
*Only* “upgrade” to derivations that have the same version. This may
|
|
||||||
not seem very useful, but it actually is, e.g., when there is a new
|
|
||||||
release of Nixpkgs and you want to replace installed applications
|
|
||||||
with the same versions built against newer dependencies (to reduce
|
|
||||||
the number of dependencies floating around on your system).
|
|
||||||
|
|
||||||
- `--always`\
|
|
||||||
In addition to upgrading to newer versions, also “upgrade” to
|
|
||||||
derivations that have the same or a lower version. I.e., derivations
|
|
||||||
may actually be downgraded depending on what is available in the
|
|
||||||
active Nix expression.
|
|
||||||
|
|
||||||
For the other flags, see `--install`.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --upgrade -A nixpkgs.gcc
|
|
||||||
upgrading `gcc-3.3.1' to `gcc-3.4'
|
|
||||||
```
|
|
||||||
|
|
||||||
When there are no updates available, nothing will happen:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --upgrade -A nixpkgs.pan
|
|
||||||
```
|
|
||||||
|
|
||||||
Using `-A` is preferred when possible, as it is faster and unambiguous but
|
|
||||||
it is also possible to upgrade to a specific version by matching the derivation name:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -u gcc-3.3.2 --always
|
|
||||||
upgrading `gcc-3.4' to `gcc-3.3.2'
|
|
||||||
```
|
|
||||||
|
|
||||||
To try to upgrade everything
|
|
||||||
(matching packages based on the part of the derivation name without version):
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -u
|
|
||||||
upgrading `hello-2.1.2' to `hello-2.1.3'
|
|
||||||
upgrading `mozilla-1.2' to `mozilla-1.4'
|
|
||||||
```
|
|
||||||
|
|
||||||
## Versions
|
|
||||||
|
|
||||||
The upgrade operation determines whether a derivation `y` is an upgrade
|
|
||||||
of a derivation `x` by looking at their respective `name` attributes.
|
|
||||||
The names (e.g., `gcc-3.3.1` are split into two parts: the package name
|
|
||||||
(`gcc`), and the version (`3.3.1`). The version part starts after the
|
|
||||||
first dash not followed by a letter. `y` is considered an upgrade of `x`
|
|
||||||
if their package names match, and the version of `y` is higher than that
|
|
||||||
of `x`.
|
|
||||||
|
|
||||||
The versions are compared by splitting them into contiguous components
|
|
||||||
of numbers and letters. E.g., `3.3.1pre5` is split into `[3, 3, 1,
|
|
||||||
"pre", 5]`. These lists are then compared lexicographically (from left
|
|
||||||
to right). Corresponding components `a` and `b` are compared as follows.
|
|
||||||
If they are both numbers, integer comparison is used. If `a` is an empty
|
|
||||||
string and `b` is a number, `a` is considered less than `b`. The special
|
|
||||||
string component `pre` (for *pre-release*) is considered to be less than
|
|
||||||
other components. String components are considered less than number
|
|
||||||
components. Otherwise, they are compared lexicographically (i.e., using
|
|
||||||
case-sensitive string comparison).
|
|
||||||
|
|
||||||
This is illustrated by the following examples:
|
|
||||||
|
|
||||||
1.0 < 2.3
|
|
||||||
2.1 < 2.3
|
|
||||||
2.3 = 2.3
|
|
||||||
2.5 > 2.3
|
|
||||||
3.1 > 2.3
|
|
||||||
2.3.1 > 2.3
|
|
||||||
2.3.1 > 2.3a
|
|
||||||
2.3pre1 < 2.3
|
|
||||||
2.3pre3 < 2.3pre12
|
|
||||||
2.3a < 2.3c
|
|
||||||
2.3pre1 < 2.3c
|
|
||||||
2.3pre1 < 2.3q
|
|
||||||
|
|
||||||
# Operation `--uninstall`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` {`--uninstall` | `-e`} *drvnames…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The uninstall operation creates a new user environment, based on the
|
|
||||||
current generation of the active profile, from which the store paths
|
|
||||||
designated by the symbolic names *drvnames* are removed.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --uninstall gcc
|
|
||||||
$ nix-env -e '.*' (remove everything)
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--set`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` `--set` *drvname*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The `--set` operation modifies the current generation of a profile so
|
|
||||||
that it contains exactly the specified derivation, and nothing else.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
The following updates a profile such that its current generation will
|
|
||||||
contain just Firefox:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -p /nix/var/nix/profiles/browser --set firefox
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--set-flag`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` `--set-flag` *name* *value* *drvnames*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The `--set-flag` operation allows meta attributes of installed packages
|
|
||||||
to be modified. There are several attributes that can be usefully
|
|
||||||
modified, because they affect the behaviour of `nix-env` or the user
|
|
||||||
environment build script:
|
|
||||||
|
|
||||||
- `priority` can be changed to resolve filename clashes. The user
|
|
||||||
environment build script uses the `meta.priority` attribute of
|
|
||||||
derivations to resolve filename collisions between packages. Lower
|
|
||||||
priority values denote a higher priority. For instance, the GCC
|
|
||||||
wrapper package and the Binutils package in Nixpkgs both have a file
|
|
||||||
`bin/ld`, so previously if you tried to install both you would get a
|
|
||||||
collision. Now, on the other hand, the GCC wrapper declares a higher
|
|
||||||
priority than Binutils, so the former’s `bin/ld` is symlinked in the
|
|
||||||
user environment.
|
|
||||||
|
|
||||||
- `keep` can be set to `true` to prevent the package from being
|
|
||||||
upgraded or replaced. This is useful if you want to hang on to an
|
|
||||||
older version of a package.
|
|
||||||
|
|
||||||
- `active` can be set to `false` to “disable” the package. That is, no
|
|
||||||
symlinks will be generated to the files of the package, but it
|
|
||||||
remains part of the profile (so it won’t be garbage-collected). It
|
|
||||||
can be set back to `true` to re-enable the package.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
To prevent the currently installed Firefox from being upgraded:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --set-flag keep true firefox
|
|
||||||
```
|
|
||||||
|
|
||||||
After this, `nix-env -u` will ignore Firefox.
|
|
||||||
|
|
||||||
To disable the currently installed Firefox, then install a new Firefox
|
|
||||||
while the old remains part of the profile:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -q
|
|
||||||
firefox-2.0.0.9 (the current one)
|
|
||||||
|
|
||||||
$ nix-env --preserve-installed -i firefox-2.0.0.11
|
|
||||||
installing `firefox-2.0.0.11'
|
|
||||||
building path(s) `/nix/store/myy0y59q3ig70dgq37jqwg1j0rsapzsl-user-environment'
|
|
||||||
collision between `/nix/store/...-firefox-2.0.0.11/bin/firefox'
|
|
||||||
and `/nix/store/...-firefox-2.0.0.9/bin/firefox'.
|
|
||||||
(i.e., can’t have two active at the same time)
|
|
||||||
|
|
||||||
$ nix-env --set-flag active false firefox
|
|
||||||
setting flag on `firefox-2.0.0.9'
|
|
||||||
|
|
||||||
$ nix-env --preserve-installed -i firefox-2.0.0.11
|
|
||||||
installing `firefox-2.0.0.11'
|
|
||||||
|
|
||||||
$ nix-env -q
|
|
||||||
firefox-2.0.0.11 (the enabled one)
|
|
||||||
firefox-2.0.0.9 (the disabled one)
|
|
||||||
```
|
|
||||||
|
|
||||||
To make files from `binutils` take precedence over files from `gcc`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --set-flag priority 5 binutils
|
|
||||||
$ nix-env --set-flag priority 10 gcc
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--query`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` {`--query` | `-q`} *names…*
|
|
||||||
[`--installed` | `--available` | `-a`]
|
|
||||||
[{`--status` | `-s`}]
|
|
||||||
[{`--attr-path` | `-P`}]
|
|
||||||
[`--no-name`]
|
|
||||||
[{`--compare-versions` | `-c`}]
|
|
||||||
[`--system`]
|
|
||||||
[`--drv-path`]
|
|
||||||
[`--out-path`]
|
|
||||||
[`--description`]
|
|
||||||
[`--meta`]
|
|
||||||
[`--xml`]
|
|
||||||
[`--json`]
|
|
||||||
[{`--prebuilt-only` | `-b`}]
|
|
||||||
[{`--attr` | `-A`} *attribute-path*]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The query operation displays information about either the store paths
|
|
||||||
that are installed in the current generation of the active profile
|
|
||||||
(`--installed`), or the derivations that are available for installation
|
|
||||||
in the active Nix expression (`--available`). It only prints information
|
|
||||||
about derivations whose symbolic name matches one of *names*.
|
|
||||||
|
|
||||||
The derivations are sorted by their `name` attributes.
|
|
||||||
|
|
||||||
## Source selection
|
|
||||||
|
|
||||||
The following flags specify the set of things on which the query
|
|
||||||
operates.
|
|
||||||
|
|
||||||
- `--installed`\
|
|
||||||
The query operates on the store paths that are installed in the
|
|
||||||
current generation of the active profile. This is the default.
|
|
||||||
|
|
||||||
- `--available`; `-a`\
|
|
||||||
The query operates on the derivations that are available in the
|
|
||||||
active Nix expression.
|
|
||||||
|
|
||||||
## Queries
|
|
||||||
|
|
||||||
The following flags specify what information to display about the
|
|
||||||
selected derivations. Multiple flags may be specified, in which case the
|
|
||||||
information is shown in the order given here. Note that the name of the
|
|
||||||
derivation is shown unless `--no-name` is specified.
|
|
||||||
|
|
||||||
- `--xml`\
|
|
||||||
Print the result in an XML representation suitable for automatic
|
|
||||||
processing by other tools. The root element is called `items`, which
|
|
||||||
contains a `item` element for each available or installed
|
|
||||||
derivation. The fields discussed below are all stored in attributes
|
|
||||||
of the `item` elements.
|
|
||||||
|
|
||||||
- `--json`\
|
|
||||||
Print the result in a JSON representation suitable for automatic
|
|
||||||
processing by other tools.
|
|
||||||
|
|
||||||
- `--prebuilt-only` / `-b`\
|
|
||||||
Show only derivations for which a substitute is registered, i.e.,
|
|
||||||
there is a pre-built binary available that can be downloaded in lieu
|
|
||||||
of building the derivation. Thus, this shows all packages that
|
|
||||||
probably can be installed quickly.
|
|
||||||
|
|
||||||
- `--status`; `-s`\
|
|
||||||
Print the *status* of the derivation. The status consists of three
|
|
||||||
characters. The first is `I` or `-`, indicating whether the
|
|
||||||
derivation is currently installed in the current generation of the
|
|
||||||
active profile. This is by definition the case for `--installed`,
|
|
||||||
but not for `--available`. The second is `P` or `-`, indicating
|
|
||||||
whether the derivation is present on the system. This indicates
|
|
||||||
whether installation of an available derivation will require the
|
|
||||||
derivation to be built. The third is `S` or `-`, indicating whether
|
|
||||||
a substitute is available for the derivation.
|
|
||||||
|
|
||||||
- `--attr-path`; `-P`\
|
|
||||||
Print the *attribute path* of the derivation, which can be used to
|
|
||||||
unambiguously select it using the `--attr` option available in
|
|
||||||
commands that install derivations like `nix-env --install`. This
|
|
||||||
option only works together with `--available`
|
|
||||||
|
|
||||||
- `--no-name`\
|
|
||||||
Suppress printing of the `name` attribute of each derivation.
|
|
||||||
|
|
||||||
- `--compare-versions` / `-c`\
|
|
||||||
Compare installed versions to available versions, or vice versa (if
|
|
||||||
`--available` is given). This is useful for quickly seeing whether
|
|
||||||
upgrades for installed packages are available in a Nix expression. A
|
|
||||||
column is added with the following meaning:
|
|
||||||
|
|
||||||
- `<` *version*\
|
|
||||||
A newer version of the package is available or installed.
|
|
||||||
|
|
||||||
- `=` *version*\
|
|
||||||
At most the same version of the package is available or
|
|
||||||
installed.
|
|
||||||
|
|
||||||
- `>` *version*\
|
|
||||||
Only older versions of the package are available or installed.
|
|
||||||
|
|
||||||
- `- ?`\
|
|
||||||
No version of the package is available or installed.
|
|
||||||
|
|
||||||
- `--system`\
|
|
||||||
Print the `system` attribute of the derivation.
|
|
||||||
|
|
||||||
- `--drv-path`\
|
|
||||||
Print the path of the [store derivation].
|
|
||||||
|
|
||||||
- `--out-path`\
|
|
||||||
Print the output path of the derivation.
|
|
||||||
|
|
||||||
- `--description`\
|
|
||||||
Print a short (one-line) description of the derivation, if
|
|
||||||
available. The description is taken from the `meta.description`
|
|
||||||
attribute of the derivation.
|
|
||||||
|
|
||||||
- `--meta`\
|
|
||||||
Print all of the meta-attributes of the derivation. This option is
|
|
||||||
only available with `--xml` or `--json`.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
To show installed packages:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -q
|
|
||||||
bison-1.875c
|
|
||||||
docbook-xml-4.2
|
|
||||||
firefox-1.0.4
|
|
||||||
MPlayer-1.0pre7
|
|
||||||
ORBit2-2.8.3
|
|
||||||
…
|
|
||||||
```
|
|
||||||
|
|
||||||
To show available packages:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -qa
|
|
||||||
firefox-1.0.7
|
|
||||||
GConf-2.4.0.1
|
|
||||||
MPlayer-1.0pre7
|
|
||||||
ORBit2-2.8.3
|
|
||||||
…
|
|
||||||
```
|
|
||||||
|
|
||||||
To show the status of available packages:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -qas
|
|
||||||
-P- firefox-1.0.7 (not installed but present)
|
|
||||||
--S GConf-2.4.0.1 (not present, but there is a substitute for fast installation)
|
|
||||||
--S MPlayer-1.0pre3 (i.e., this is not the installed MPlayer, even though the version is the same!)
|
|
||||||
IP- ORBit2-2.8.3 (installed and by definition present)
|
|
||||||
…
|
|
||||||
```
|
|
||||||
|
|
||||||
To show available packages in the Nix expression `foo.nix`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -f ./foo.nix -qa
|
|
||||||
foo-1.2.3
|
|
||||||
```
|
|
||||||
|
|
||||||
To compare installed versions to what’s available:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -qc
|
|
||||||
...
|
|
||||||
acrobat-reader-7.0 - ? (package is not available at all)
|
|
||||||
autoconf-2.59 = 2.59 (same version)
|
|
||||||
firefox-1.0.4 < 1.0.7 (a more recent version is available)
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
To show all packages with “`zip`” in the name:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -qa '.*zip.*'
|
|
||||||
bzip2-1.0.6
|
|
||||||
gzip-1.6
|
|
||||||
zip-3.0
|
|
||||||
…
|
|
||||||
```
|
|
||||||
|
|
||||||
To show all packages with “`firefox`” or “`chromium`” in the name:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -qa '.*(firefox|chromium).*'
|
|
||||||
chromium-37.0.2062.94
|
|
||||||
chromium-beta-38.0.2125.24
|
|
||||||
firefox-32.0.3
|
|
||||||
firefox-with-plugins-13.0.1
|
|
||||||
…
|
|
||||||
```
|
|
||||||
|
|
||||||
To show all packages in the latest revision of the Nixpkgs repository:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -f https://github.com/NixOS/nixpkgs/archive/master.tar.gz -qa
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--switch-profile`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` {`--switch-profile` | `-S`} *path*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This operation makes *path* the current profile for the user. That is,
|
|
||||||
the symlink `~/.nix-profile` is made to point to *path*.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -S ~/my-profile
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--list-generations`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` `--list-generations`
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This operation print a list of all the currently existing generations
|
|
||||||
for the active profile. These may be switched to using the
|
|
||||||
`--switch-generation` operation. It also prints the creation date of the
|
|
||||||
generation, and indicates the current generation.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --list-generations
|
|
||||||
95 2004-02-06 11:48:24
|
|
||||||
96 2004-02-06 11:49:01
|
|
||||||
97 2004-02-06 16:22:45
|
|
||||||
98 2004-02-06 16:24:33 (current)
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--delete-generations`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` `--delete-generations` *generations*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This operation deletes the specified generations of the current profile.
|
|
||||||
The generations can be a list of generation numbers, the special value
|
|
||||||
`old` to delete all non-current generations, a value such as `30d` to
|
|
||||||
delete all generations older than the specified number of days (except
|
|
||||||
for the generation that was active at that point in time), or a value
|
|
||||||
such as `+5` to keep the last `5` generations ignoring any newer than
|
|
||||||
current, e.g., if `30` is the current generation `+5` will delete
|
|
||||||
generation `25` and all older generations. Periodically deleting old
|
|
||||||
generations is important to make garbage collection effective.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --delete-generations 3 4 8
|
|
||||||
```
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --delete-generations +5
|
|
||||||
```
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --delete-generations 30d
|
|
||||||
```
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -p other_profile --delete-generations old
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--switch-generation`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` {`--switch-generation` | `-G`} *generation*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This operation makes generation number *generation* the current
|
|
||||||
generation of the active profile. That is, if the `profile` is the path
|
|
||||||
to the active profile, then the symlink `profile` is made to point to
|
|
||||||
`profile-generation-link`, which is in turn a symlink to the actual user
|
|
||||||
environment in the Nix store.
|
|
||||||
|
|
||||||
Switching will fail if the specified generation does not exist.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env -G 42
|
|
||||||
switching from generation 50 to 42
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--rollback`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-env` `--rollback`
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This operation switches to the “previous” generation of the active
|
|
||||||
profile, that is, the highest numbered generation lower than the current
|
|
||||||
generation, if it exists. It is just a convenience wrapper around
|
|
||||||
`--list-generations` and `--switch-generation`.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --rollback
|
|
||||||
switching from generation 92 to 91
|
|
||||||
```
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-env --rollback
|
|
||||||
error: no generation older than the current (91) exists
|
|
||||||
```
|
|
||||||
|
|
||||||
# Environment variables
|
|
||||||
|
|
||||||
- `NIX_PROFILE`\
|
|
||||||
Location of the Nix profile. Defaults to the target of the symlink
|
|
||||||
`~/.nix-profile`, if it exists, or `/nix/var/nix/profiles/default`
|
|
||||||
otherwise.
|
|
||||||
|
|
|
||||||
46
doc/manual/src/command-ref/nix-env/delete-generations.md
Normal file
46
doc/manual/src/command-ref/nix-env/delete-generations.md
Normal file
|
|
@ -0,0 +1,46 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --delete-generations` - delete profile generations
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` `--delete-generations` *generations*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
This operation deletes the specified generations of the current profile.
|
||||||
|
The generations can be a list of generation numbers, the special value
|
||||||
|
`old` to delete all non-current generations, a value such as `30d` to
|
||||||
|
delete all generations older than the specified number of days (except
|
||||||
|
for the generation that was active at that point in time), or a value
|
||||||
|
such as `+5` to keep the last `5` generations ignoring any newer than
|
||||||
|
current, e.g., if `30` is the current generation `+5` will delete
|
||||||
|
generation `25` and all older generations. Periodically deleting old
|
||||||
|
generations is important to make garbage collection effective.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --delete-generations 3 4 8
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --delete-generations +5
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --delete-generations 30d
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -p other_profile --delete-generations old
|
||||||
|
```
|
||||||
|
|
||||||
6
doc/manual/src/command-ref/nix-env/env-common.md
Normal file
6
doc/manual/src/command-ref/nix-env/env-common.md
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
# Environment variables
|
||||||
|
|
||||||
|
- `NIX_PROFILE`\
|
||||||
|
Location of the Nix profile. Defaults to the target of the symlink
|
||||||
|
`~/.nix-profile`, if it exists, or `/nix/var/nix/profiles/default`
|
||||||
|
otherwise.
|
||||||
187
doc/manual/src/command-ref/nix-env/install.md
Normal file
187
doc/manual/src/command-ref/nix-env/install.md
Normal file
|
|
@ -0,0 +1,187 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --install` - add packages to user environment
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` {`--install` | `-i`} *args…*
|
||||||
|
[{`--prebuilt-only` | `-b`}]
|
||||||
|
[{`--attr` | `-A`}]
|
||||||
|
[`--from-expression`] [`-E`]
|
||||||
|
[`--from-profile` *path*]
|
||||||
|
[`--preserve-installed` | `-P`]
|
||||||
|
[`--remove-all` | `-r`]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The install operation creates a new user environment, based on the
|
||||||
|
current generation of the active profile, to which a set of store paths
|
||||||
|
described by *args* is added. The arguments *args* map to store paths in
|
||||||
|
a number of possible ways:
|
||||||
|
|
||||||
|
- By default, *args* is a set of derivation names denoting derivations
|
||||||
|
in the active Nix expression. These are realised, and the resulting
|
||||||
|
output paths are installed. Currently installed derivations with a
|
||||||
|
name equal to the name of a derivation being added are removed
|
||||||
|
unless the option `--preserve-installed` is specified.
|
||||||
|
|
||||||
|
If there are multiple derivations matching a name in *args* that
|
||||||
|
have the same name (e.g., `gcc-3.3.6` and `gcc-4.1.1`), then the
|
||||||
|
derivation with the highest *priority* is used. A derivation can
|
||||||
|
define a priority by declaring the `meta.priority` attribute. This
|
||||||
|
attribute should be a number, with a higher value denoting a lower
|
||||||
|
priority. The default priority is `0`.
|
||||||
|
|
||||||
|
If there are multiple matching derivations with the same priority,
|
||||||
|
then the derivation with the highest version will be installed.
|
||||||
|
|
||||||
|
You can force the installation of multiple derivations with the same
|
||||||
|
name by being specific about the versions. For instance, `nix-env -i
|
||||||
|
gcc-3.3.6 gcc-4.1.1` will install both version of GCC (and will
|
||||||
|
probably cause a user environment conflict\!).
|
||||||
|
|
||||||
|
- If `--attr` (`-A`) is specified, the arguments are *attribute
|
||||||
|
paths* that select attributes from the top-level Nix
|
||||||
|
expression. This is faster than using derivation names and
|
||||||
|
unambiguous. To find out the attribute paths of available
|
||||||
|
packages, use `nix-env -qaP`.
|
||||||
|
|
||||||
|
- If `--from-profile` *path* is given, *args* is a set of names
|
||||||
|
denoting installed store paths in the profile *path*. This is an
|
||||||
|
easy way to copy user environment elements from one profile to
|
||||||
|
another.
|
||||||
|
|
||||||
|
- If `--from-expression` is given, *args* are Nix
|
||||||
|
[functions](@docroot@/language/constructs.md#functions)
|
||||||
|
that are called with the active Nix expression as their single
|
||||||
|
argument. The derivations returned by those function calls are
|
||||||
|
installed. This allows derivations to be specified in an
|
||||||
|
unambiguous way, which is necessary if there are multiple
|
||||||
|
derivations with the same name.
|
||||||
|
|
||||||
|
- If *args* are [store derivations](@docroot@/glossary.md#gloss-store-derivation), then these are
|
||||||
|
[realised](@docroot@/command-ref/nix-store/realise.md), and the resulting output paths
|
||||||
|
are installed.
|
||||||
|
|
||||||
|
- If *args* are store paths that are not store derivations, then these
|
||||||
|
are [realised](@docroot@/command-ref/nix-store/realise.md) and installed.
|
||||||
|
|
||||||
|
- By default all outputs are installed for each derivation. That can
|
||||||
|
be reduced by setting `meta.outputsToInstall`.
|
||||||
|
|
||||||
|
# Flags
|
||||||
|
|
||||||
|
- `--prebuilt-only` / `-b`\
|
||||||
|
Use only derivations for which a substitute is registered, i.e.,
|
||||||
|
there is a pre-built binary available that can be downloaded in lieu
|
||||||
|
of building the derivation. Thus, no packages will be built from
|
||||||
|
source.
|
||||||
|
|
||||||
|
- `--preserve-installed` / `-P`\
|
||||||
|
Do not remove derivations with a name matching one of the
|
||||||
|
derivations being installed. Usually, trying to have two versions of
|
||||||
|
the same package installed in the same generation of a profile will
|
||||||
|
lead to an error in building the generation, due to file name
|
||||||
|
clashes between the two versions. However, this is not the case for
|
||||||
|
all packages.
|
||||||
|
|
||||||
|
- `--remove-all` / `-r`\
|
||||||
|
Remove all previously installed packages first. This is equivalent
|
||||||
|
to running `nix-env -e '.*'` first, except that everything happens
|
||||||
|
in a single transaction.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
To install a package using a specific attribute path from the active Nix expression:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -iA gcc40mips
|
||||||
|
installing `gcc-4.0.2'
|
||||||
|
$ nix-env -iA xorg.xorgserver
|
||||||
|
installing `xorg-server-1.2.0'
|
||||||
|
```
|
||||||
|
|
||||||
|
To install a specific version of `gcc` using the derivation name:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --install gcc-3.3.2
|
||||||
|
installing `gcc-3.3.2'
|
||||||
|
uninstalling `gcc-3.1'
|
||||||
|
```
|
||||||
|
|
||||||
|
Using attribute path for selecting a package is preferred,
|
||||||
|
as it is much faster and there will not be multiple matches.
|
||||||
|
|
||||||
|
Note the previously installed version is removed, since
|
||||||
|
`--preserve-installed` was not specified.
|
||||||
|
|
||||||
|
To install an arbitrary version:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --install gcc
|
||||||
|
installing `gcc-3.3.2'
|
||||||
|
```
|
||||||
|
|
||||||
|
To install all derivations in the Nix expression `foo.nix`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -f ~/foo.nix -i '.*'
|
||||||
|
```
|
||||||
|
|
||||||
|
To copy the store path with symbolic name `gcc` from another profile:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -i --from-profile /nix/var/nix/profiles/foo gcc
|
||||||
|
```
|
||||||
|
|
||||||
|
To install a specific [store derivation] (typically created by
|
||||||
|
`nix-instantiate`):
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -i /nix/store/fibjb1bfbpm5mrsxc4mh2d8n37sxh91i-gcc-3.4.3.drv
|
||||||
|
```
|
||||||
|
|
||||||
|
To install a specific output path:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -i /nix/store/y3cgx0xj1p4iv9x0pnnmdhr8iyg741vk-gcc-3.4.3
|
||||||
|
```
|
||||||
|
|
||||||
|
To install from a Nix expression specified on the command-line:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -f ./foo.nix -i -E \
|
||||||
|
'f: (f {system = "i686-linux";}).subversionWithJava'
|
||||||
|
```
|
||||||
|
|
||||||
|
I.e., this evaluates to `(f: (f {system =
|
||||||
|
"i686-linux";}).subversionWithJava) (import ./foo.nix)`, thus selecting
|
||||||
|
the `subversionWithJava` attribute from the set returned by calling the
|
||||||
|
function defined in `./foo.nix`.
|
||||||
|
|
||||||
|
A dry-run tells you which paths will be downloaded or built from source:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -f '<nixpkgs>' -iA hello --dry-run
|
||||||
|
(dry run; not doing anything)
|
||||||
|
installing ‘hello-2.10’
|
||||||
|
this path will be fetched (0.04 MiB download, 0.19 MiB unpacked):
|
||||||
|
/nix/store/wkhdf9jinag5750mqlax6z2zbwhqb76n-hello-2.10
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
To install Firefox from the latest revision in the Nixpkgs/NixOS 14.12
|
||||||
|
channel:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -f https://github.com/NixOS/nixpkgs/archive/nixos-14.12.tar.gz -iA firefox
|
||||||
|
```
|
||||||
|
|
||||||
33
doc/manual/src/command-ref/nix-env/list-generations.md
Normal file
33
doc/manual/src/command-ref/nix-env/list-generations.md
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --list-generations` - list profile generations
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` `--list-generations`
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
This operation print a list of all the currently existing generations
|
||||||
|
for the active profile. These may be switched to using the
|
||||||
|
`--switch-generation` operation. It also prints the creation date of the
|
||||||
|
generation, and indicates the current generation.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --list-generations
|
||||||
|
95 2004-02-06 11:48:24
|
||||||
|
96 2004-02-06 11:49:01
|
||||||
|
97 2004-02-06 16:22:45
|
||||||
|
98 2004-02-06 16:24:33 (current)
|
||||||
|
```
|
||||||
|
|
||||||
35
doc/manual/src/command-ref/nix-env/opt-common.md
Normal file
35
doc/manual/src/command-ref/nix-env/opt-common.md
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Options
|
||||||
|
|
||||||
|
The following options are allowed for all `nix-env` operations, but may not always have an effect.
|
||||||
|
|
||||||
|
- `--file` / `-f` *path*\
|
||||||
|
Specifies the Nix expression (designated below as the *active Nix
|
||||||
|
expression*) used by the `--install`, `--upgrade`, and `--query
|
||||||
|
--available` operations to obtain derivations. The default is
|
||||||
|
`~/.nix-defexpr`.
|
||||||
|
|
||||||
|
If the argument starts with `http://` or `https://`, it is
|
||||||
|
interpreted as the URL of a tarball that will be downloaded and
|
||||||
|
unpacked to a temporary location. The tarball must include a single
|
||||||
|
top-level directory containing at least a file named `default.nix`.
|
||||||
|
|
||||||
|
- `--profile` / `-p` *path*\
|
||||||
|
Specifies the profile to be used by those operations that operate on
|
||||||
|
a profile (designated below as the *active profile*). A profile is a
|
||||||
|
sequence of user environments called *generations*, one of which is
|
||||||
|
the *current generation*.
|
||||||
|
|
||||||
|
- `--dry-run`\
|
||||||
|
For the `--install`, `--upgrade`, `--uninstall`,
|
||||||
|
`--switch-generation`, `--delete-generations` and `--rollback`
|
||||||
|
operations, this flag will cause `nix-env` to print what *would* be
|
||||||
|
done if this flag had not been specified, without actually doing it.
|
||||||
|
|
||||||
|
`--dry-run` also prints out which paths will be
|
||||||
|
[substituted](@docroot@/glossary.md) (i.e., downloaded) and which paths
|
||||||
|
will be built from source (because no substitute is available).
|
||||||
|
|
||||||
|
- `--system-filter` *system*\
|
||||||
|
By default, operations such as `--query
|
||||||
|
--available` show derivations matching any platform. This option
|
||||||
|
allows you to use derivations for the specified platform *system*.
|
||||||
215
doc/manual/src/command-ref/nix-env/query.md
Normal file
215
doc/manual/src/command-ref/nix-env/query.md
Normal file
|
|
@ -0,0 +1,215 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --query` - display information about packages
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` {`--query` | `-q`} *names…*
|
||||||
|
[`--installed` | `--available` | `-a`]
|
||||||
|
[{`--status` | `-s`}]
|
||||||
|
[{`--attr-path` | `-P`}]
|
||||||
|
[`--no-name`]
|
||||||
|
[{`--compare-versions` | `-c`}]
|
||||||
|
[`--system`]
|
||||||
|
[`--drv-path`]
|
||||||
|
[`--out-path`]
|
||||||
|
[`--description`]
|
||||||
|
[`--meta`]
|
||||||
|
[`--xml`]
|
||||||
|
[`--json`]
|
||||||
|
[{`--prebuilt-only` | `-b`}]
|
||||||
|
[{`--attr` | `-A`} *attribute-path*]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The query operation displays information about either the store paths
|
||||||
|
that are installed in the current generation of the active profile
|
||||||
|
(`--installed`), or the derivations that are available for installation
|
||||||
|
in the active Nix expression (`--available`). It only prints information
|
||||||
|
about derivations whose symbolic name matches one of *names*.
|
||||||
|
|
||||||
|
The derivations are sorted by their `name` attributes.
|
||||||
|
|
||||||
|
# Source selection
|
||||||
|
|
||||||
|
The following flags specify the set of things on which the query
|
||||||
|
operates.
|
||||||
|
|
||||||
|
- `--installed`\
|
||||||
|
The query operates on the store paths that are installed in the
|
||||||
|
current generation of the active profile. This is the default.
|
||||||
|
|
||||||
|
- `--available`; `-a`\
|
||||||
|
The query operates on the derivations that are available in the
|
||||||
|
active Nix expression.
|
||||||
|
|
||||||
|
# Queries
|
||||||
|
|
||||||
|
The following flags specify what information to display about the
|
||||||
|
selected derivations. Multiple flags may be specified, in which case the
|
||||||
|
information is shown in the order given here. Note that the name of the
|
||||||
|
derivation is shown unless `--no-name` is specified.
|
||||||
|
|
||||||
|
- `--xml`\
|
||||||
|
Print the result in an XML representation suitable for automatic
|
||||||
|
processing by other tools. The root element is called `items`, which
|
||||||
|
contains a `item` element for each available or installed
|
||||||
|
derivation. The fields discussed below are all stored in attributes
|
||||||
|
of the `item` elements.
|
||||||
|
|
||||||
|
- `--json`\
|
||||||
|
Print the result in a JSON representation suitable for automatic
|
||||||
|
processing by other tools.
|
||||||
|
|
||||||
|
- `--prebuilt-only` / `-b`\
|
||||||
|
Show only derivations for which a substitute is registered, i.e.,
|
||||||
|
there is a pre-built binary available that can be downloaded in lieu
|
||||||
|
of building the derivation. Thus, this shows all packages that
|
||||||
|
probably can be installed quickly.
|
||||||
|
|
||||||
|
- `--status`; `-s`\
|
||||||
|
Print the *status* of the derivation. The status consists of three
|
||||||
|
characters. The first is `I` or `-`, indicating whether the
|
||||||
|
derivation is currently installed in the current generation of the
|
||||||
|
active profile. This is by definition the case for `--installed`,
|
||||||
|
but not for `--available`. The second is `P` or `-`, indicating
|
||||||
|
whether the derivation is present on the system. This indicates
|
||||||
|
whether installation of an available derivation will require the
|
||||||
|
derivation to be built. The third is `S` or `-`, indicating whether
|
||||||
|
a substitute is available for the derivation.
|
||||||
|
|
||||||
|
- `--attr-path`; `-P`\
|
||||||
|
Print the *attribute path* of the derivation, which can be used to
|
||||||
|
unambiguously select it using the `--attr` option available in
|
||||||
|
commands that install derivations like `nix-env --install`. This
|
||||||
|
option only works together with `--available`
|
||||||
|
|
||||||
|
- `--no-name`\
|
||||||
|
Suppress printing of the `name` attribute of each derivation.
|
||||||
|
|
||||||
|
- `--compare-versions` / `-c`\
|
||||||
|
Compare installed versions to available versions, or vice versa (if
|
||||||
|
`--available` is given). This is useful for quickly seeing whether
|
||||||
|
upgrades for installed packages are available in a Nix expression. A
|
||||||
|
column is added with the following meaning:
|
||||||
|
|
||||||
|
- `<` *version*\
|
||||||
|
A newer version of the package is available or installed.
|
||||||
|
|
||||||
|
- `=` *version*\
|
||||||
|
At most the same version of the package is available or
|
||||||
|
installed.
|
||||||
|
|
||||||
|
- `>` *version*\
|
||||||
|
Only older versions of the package are available or installed.
|
||||||
|
|
||||||
|
- `- ?`\
|
||||||
|
No version of the package is available or installed.
|
||||||
|
|
||||||
|
- `--system`\
|
||||||
|
Print the `system` attribute of the derivation.
|
||||||
|
|
||||||
|
- `--drv-path`\
|
||||||
|
Print the path of the [store derivation](@docroot@/glossary.md#gloss-store-derivation).
|
||||||
|
|
||||||
|
- `--out-path`\
|
||||||
|
Print the output path of the derivation.
|
||||||
|
|
||||||
|
- `--description`\
|
||||||
|
Print a short (one-line) description of the derivation, if
|
||||||
|
available. The description is taken from the `meta.description`
|
||||||
|
attribute of the derivation.
|
||||||
|
|
||||||
|
- `--meta`\
|
||||||
|
Print all of the meta-attributes of the derivation. This option is
|
||||||
|
only available with `--xml` or `--json`.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
To show installed packages:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -q
|
||||||
|
bison-1.875c
|
||||||
|
docbook-xml-4.2
|
||||||
|
firefox-1.0.4
|
||||||
|
MPlayer-1.0pre7
|
||||||
|
ORBit2-2.8.3
|
||||||
|
…
|
||||||
|
```
|
||||||
|
|
||||||
|
To show available packages:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -qa
|
||||||
|
firefox-1.0.7
|
||||||
|
GConf-2.4.0.1
|
||||||
|
MPlayer-1.0pre7
|
||||||
|
ORBit2-2.8.3
|
||||||
|
…
|
||||||
|
```
|
||||||
|
|
||||||
|
To show the status of available packages:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -qas
|
||||||
|
-P- firefox-1.0.7 (not installed but present)
|
||||||
|
--S GConf-2.4.0.1 (not present, but there is a substitute for fast installation)
|
||||||
|
--S MPlayer-1.0pre3 (i.e., this is not the installed MPlayer, even though the version is the same!)
|
||||||
|
IP- ORBit2-2.8.3 (installed and by definition present)
|
||||||
|
…
|
||||||
|
```
|
||||||
|
|
||||||
|
To show available packages in the Nix expression `foo.nix`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -f ./foo.nix -qa
|
||||||
|
foo-1.2.3
|
||||||
|
```
|
||||||
|
|
||||||
|
To compare installed versions to what’s available:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -qc
|
||||||
|
...
|
||||||
|
acrobat-reader-7.0 - ? (package is not available at all)
|
||||||
|
autoconf-2.59 = 2.59 (same version)
|
||||||
|
firefox-1.0.4 < 1.0.7 (a more recent version is available)
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
To show all packages with “`zip`” in the name:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -qa '.*zip.*'
|
||||||
|
bzip2-1.0.6
|
||||||
|
gzip-1.6
|
||||||
|
zip-3.0
|
||||||
|
…
|
||||||
|
```
|
||||||
|
|
||||||
|
To show all packages with “`firefox`” or “`chromium`” in the name:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -qa '.*(firefox|chromium).*'
|
||||||
|
chromium-37.0.2062.94
|
||||||
|
chromium-beta-38.0.2125.24
|
||||||
|
firefox-32.0.3
|
||||||
|
firefox-with-plugins-13.0.1
|
||||||
|
…
|
||||||
|
```
|
||||||
|
|
||||||
|
To show all packages in the latest revision of the Nixpkgs repository:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -f https://github.com/NixOS/nixpkgs/archive/master.tar.gz -qa
|
||||||
|
```
|
||||||
|
|
||||||
34
doc/manual/src/command-ref/nix-env/rollback.md
Normal file
34
doc/manual/src/command-ref/nix-env/rollback.md
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --rollback` - set user environment to previous generation
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` `--rollback`
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
This operation switches to the “previous” generation of the active
|
||||||
|
profile, that is, the highest numbered generation lower than the current
|
||||||
|
generation, if it exists. It is just a convenience wrapper around
|
||||||
|
`--list-generations` and `--switch-generation`.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --rollback
|
||||||
|
switching from generation 92 to 91
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --rollback
|
||||||
|
error: no generation older than the current (91) exists
|
||||||
|
```
|
||||||
82
doc/manual/src/command-ref/nix-env/set-flag.md
Normal file
82
doc/manual/src/command-ref/nix-env/set-flag.md
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --set-flag` - modify meta attributes of installed packages
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` `--set-flag` *name* *value* *drvnames*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The `--set-flag` operation allows meta attributes of installed packages
|
||||||
|
to be modified. There are several attributes that can be usefully
|
||||||
|
modified, because they affect the behaviour of `nix-env` or the user
|
||||||
|
environment build script:
|
||||||
|
|
||||||
|
- `priority` can be changed to resolve filename clashes. The user
|
||||||
|
environment build script uses the `meta.priority` attribute of
|
||||||
|
derivations to resolve filename collisions between packages. Lower
|
||||||
|
priority values denote a higher priority. For instance, the GCC
|
||||||
|
wrapper package and the Binutils package in Nixpkgs both have a file
|
||||||
|
`bin/ld`, so previously if you tried to install both you would get a
|
||||||
|
collision. Now, on the other hand, the GCC wrapper declares a higher
|
||||||
|
priority than Binutils, so the former’s `bin/ld` is symlinked in the
|
||||||
|
user environment.
|
||||||
|
|
||||||
|
- `keep` can be set to `true` to prevent the package from being
|
||||||
|
upgraded or replaced. This is useful if you want to hang on to an
|
||||||
|
older version of a package.
|
||||||
|
|
||||||
|
- `active` can be set to `false` to “disable” the package. That is, no
|
||||||
|
symlinks will be generated to the files of the package, but it
|
||||||
|
remains part of the profile (so it won’t be garbage-collected). It
|
||||||
|
can be set back to `true` to re-enable the package.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
To prevent the currently installed Firefox from being upgraded:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --set-flag keep true firefox
|
||||||
|
```
|
||||||
|
|
||||||
|
After this, `nix-env -u` will ignore Firefox.
|
||||||
|
|
||||||
|
To disable the currently installed Firefox, then install a new Firefox
|
||||||
|
while the old remains part of the profile:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -q
|
||||||
|
firefox-2.0.0.9 (the current one)
|
||||||
|
|
||||||
|
$ nix-env --preserve-installed -i firefox-2.0.0.11
|
||||||
|
installing `firefox-2.0.0.11'
|
||||||
|
building path(s) `/nix/store/myy0y59q3ig70dgq37jqwg1j0rsapzsl-user-environment'
|
||||||
|
collision between `/nix/store/...-firefox-2.0.0.11/bin/firefox'
|
||||||
|
and `/nix/store/...-firefox-2.0.0.9/bin/firefox'.
|
||||||
|
(i.e., can’t have two active at the same time)
|
||||||
|
|
||||||
|
$ nix-env --set-flag active false firefox
|
||||||
|
setting flag on `firefox-2.0.0.9'
|
||||||
|
|
||||||
|
$ nix-env --preserve-installed -i firefox-2.0.0.11
|
||||||
|
installing `firefox-2.0.0.11'
|
||||||
|
|
||||||
|
$ nix-env -q
|
||||||
|
firefox-2.0.0.11 (the enabled one)
|
||||||
|
firefox-2.0.0.9 (the disabled one)
|
||||||
|
```
|
||||||
|
|
||||||
|
To make files from `binutils` take precedence over files from `gcc`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --set-flag priority 5 binutils
|
||||||
|
$ nix-env --set-flag priority 10 gcc
|
||||||
|
```
|
||||||
|
|
||||||
30
doc/manual/src/command-ref/nix-env/set.md
Normal file
30
doc/manual/src/command-ref/nix-env/set.md
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --set` - set profile to contain a specified derivation
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-env` `--set` *drvname*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The `--set` operation modifies the current generation of a profile so
|
||||||
|
that it contains exactly the specified derivation, and nothing else.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
The following updates a profile such that its current generation will
|
||||||
|
contain just Firefox:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -p /nix/var/nix/profiles/browser --set firefox
|
||||||
|
```
|
||||||
|
|
||||||
33
doc/manual/src/command-ref/nix-env/switch-generation.md
Normal file
33
doc/manual/src/command-ref/nix-env/switch-generation.md
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --switch-generation` - set user environment to given profile generation
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` {`--switch-generation` | `-G`} *generation*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
This operation makes generation number *generation* the current
|
||||||
|
generation of the active profile. That is, if the `profile` is the path
|
||||||
|
to the active profile, then the symlink `profile` is made to point to
|
||||||
|
`profile-generation-link`, which is in turn a symlink to the actual user
|
||||||
|
environment in the Nix store.
|
||||||
|
|
||||||
|
Switching will fail if the specified generation does not exist.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -G 42
|
||||||
|
switching from generation 50 to 42
|
||||||
|
```
|
||||||
|
|
||||||
26
doc/manual/src/command-ref/nix-env/switch-profile.md
Normal file
26
doc/manual/src/command-ref/nix-env/switch-profile.md
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --switch-profile` - set user environment to given profile
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` {`--switch-profile` | `-S`} *path*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
This operation makes *path* the current profile for the user. That is,
|
||||||
|
the symlink `~/.nix-profile` is made to point to *path*.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -S ~/my-profile
|
||||||
|
```
|
||||||
28
doc/manual/src/command-ref/nix-env/uninstall.md
Normal file
28
doc/manual/src/command-ref/nix-env/uninstall.md
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --uninstall` - remove packages from user environment
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` {`--uninstall` | `-e`} *drvnames…*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The uninstall operation creates a new user environment, based on the
|
||||||
|
current generation of the active profile, from which the store paths
|
||||||
|
designated by the symbolic names *drvnames* are removed.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --uninstall gcc
|
||||||
|
$ nix-env -e '.*' (remove everything)
|
||||||
|
```
|
||||||
141
doc/manual/src/command-ref/nix-env/upgrade.md
Normal file
141
doc/manual/src/command-ref/nix-env/upgrade.md
Normal file
|
|
@ -0,0 +1,141 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-env --upgrade` - upgrade packages in user environment
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-env` {`--upgrade` | `-u`} *args*
|
||||||
|
[`--lt` | `--leq` | `--eq` | `--always`]
|
||||||
|
[{`--prebuilt-only` | `-b`}]
|
||||||
|
[{`--attr` | `-A`}]
|
||||||
|
[`--from-expression`] [`-E`]
|
||||||
|
[`--from-profile` *path*]
|
||||||
|
[`--preserve-installed` | `-P`]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The upgrade operation creates a new user environment, based on the
|
||||||
|
current generation of the active profile, in which all store paths are
|
||||||
|
replaced for which there are newer versions in the set of paths
|
||||||
|
described by *args*. Paths for which there are no newer versions are
|
||||||
|
left untouched; this is not an error. It is also not an error if an
|
||||||
|
element of *args* matches no installed derivations.
|
||||||
|
|
||||||
|
For a description of how *args* is mapped to a set of store paths, see
|
||||||
|
[`--install`](#operation---install). If *args* describes multiple
|
||||||
|
store paths with the same symbolic name, only the one with the highest
|
||||||
|
version is installed.
|
||||||
|
|
||||||
|
# Flags
|
||||||
|
|
||||||
|
- `--lt`\
|
||||||
|
Only upgrade a derivation to newer versions. This is the default.
|
||||||
|
|
||||||
|
- `--leq`\
|
||||||
|
In addition to upgrading to newer versions, also “upgrade” to
|
||||||
|
derivations that have the same version. Version are not a unique
|
||||||
|
identification of a derivation, so there may be many derivations
|
||||||
|
that have the same version. This flag may be useful to force
|
||||||
|
“synchronisation” between the installed and available derivations.
|
||||||
|
|
||||||
|
- `--eq`\
|
||||||
|
*Only* “upgrade” to derivations that have the same version. This may
|
||||||
|
not seem very useful, but it actually is, e.g., when there is a new
|
||||||
|
release of Nixpkgs and you want to replace installed applications
|
||||||
|
with the same versions built against newer dependencies (to reduce
|
||||||
|
the number of dependencies floating around on your system).
|
||||||
|
|
||||||
|
- `--always`\
|
||||||
|
In addition to upgrading to newer versions, also “upgrade” to
|
||||||
|
derivations that have the same or a lower version. I.e., derivations
|
||||||
|
may actually be downgraded depending on what is available in the
|
||||||
|
active Nix expression.
|
||||||
|
|
||||||
|
- `--prebuilt-only` / `-b`\
|
||||||
|
Use only derivations for which a substitute is registered, i.e.,
|
||||||
|
there is a pre-built binary available that can be downloaded in lieu
|
||||||
|
of building the derivation. Thus, no packages will be built from
|
||||||
|
source.
|
||||||
|
|
||||||
|
- `--preserve-installed` / `-P`\
|
||||||
|
Do not remove derivations with a name matching one of the
|
||||||
|
derivations being installed. Usually, trying to have two versions of
|
||||||
|
the same package installed in the same generation of a profile will
|
||||||
|
lead to an error in building the generation, due to file name
|
||||||
|
clashes between the two versions. However, this is not the case for
|
||||||
|
all packages.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --upgrade -A nixpkgs.gcc
|
||||||
|
upgrading `gcc-3.3.1' to `gcc-3.4'
|
||||||
|
```
|
||||||
|
|
||||||
|
When there are no updates available, nothing will happen:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env --upgrade -A nixpkgs.pan
|
||||||
|
```
|
||||||
|
|
||||||
|
Using `-A` is preferred when possible, as it is faster and unambiguous but
|
||||||
|
it is also possible to upgrade to a specific version by matching the derivation name:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -u gcc-3.3.2 --always
|
||||||
|
upgrading `gcc-3.4' to `gcc-3.3.2'
|
||||||
|
```
|
||||||
|
|
||||||
|
To try to upgrade everything
|
||||||
|
(matching packages based on the part of the derivation name without version):
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-env -u
|
||||||
|
upgrading `hello-2.1.2' to `hello-2.1.3'
|
||||||
|
upgrading `mozilla-1.2' to `mozilla-1.4'
|
||||||
|
```
|
||||||
|
|
||||||
|
# Versions
|
||||||
|
|
||||||
|
The upgrade operation determines whether a derivation `y` is an upgrade
|
||||||
|
of a derivation `x` by looking at their respective `name` attributes.
|
||||||
|
The names (e.g., `gcc-3.3.1` are split into two parts: the package name
|
||||||
|
(`gcc`), and the version (`3.3.1`). The version part starts after the
|
||||||
|
first dash not followed by a letter. `y` is considered an upgrade of `x`
|
||||||
|
if their package names match, and the version of `y` is higher than that
|
||||||
|
of `x`.
|
||||||
|
|
||||||
|
The versions are compared by splitting them into contiguous components
|
||||||
|
of numbers and letters. E.g., `3.3.1pre5` is split into `[3, 3, 1,
|
||||||
|
"pre", 5]`. These lists are then compared lexicographically (from left
|
||||||
|
to right). Corresponding components `a` and `b` are compared as follows.
|
||||||
|
If they are both numbers, integer comparison is used. If `a` is an empty
|
||||||
|
string and `b` is a number, `a` is considered less than `b`. The special
|
||||||
|
string component `pre` (for *pre-release*) is considered to be less than
|
||||||
|
other components. String components are considered less than number
|
||||||
|
components. Otherwise, they are compared lexicographically (i.e., using
|
||||||
|
case-sensitive string comparison).
|
||||||
|
|
||||||
|
This is illustrated by the following examples:
|
||||||
|
|
||||||
|
1.0 < 2.3
|
||||||
|
2.1 < 2.3
|
||||||
|
2.3 = 2.3
|
||||||
|
2.5 > 2.3
|
||||||
|
3.1 > 2.3
|
||||||
|
2.3.1 > 2.3
|
||||||
|
2.3.1 > 2.3a
|
||||||
|
2.3pre1 < 2.3
|
||||||
|
2.3pre3 < 2.3pre12
|
||||||
|
2.3a < 2.3c
|
||||||
|
2.3pre1 < 2.3c
|
||||||
|
2.3pre1 < 2.3q
|
||||||
|
|
||||||
|
|
@ -6,9 +6,7 @@
|
||||||
|
|
||||||
`nix-hash` [`--flat`] [`--base32`] [`--truncate`] [`--type` *hashAlgo*] *path…*
|
`nix-hash` [`--flat`] [`--base32`] [`--truncate`] [`--type` *hashAlgo*] *path…*
|
||||||
|
|
||||||
`nix-hash` `--to-base16` *hash…*
|
`nix-hash` [`--to-base16`|`--to-base32`|`--to-base64`|`--to-sri`] [`--type` *hashAlgo*] *hash…*
|
||||||
|
|
||||||
`nix-hash` `--to-base32` *hash…*
|
|
||||||
|
|
||||||
# Description
|
# Description
|
||||||
|
|
||||||
|
|
@ -23,7 +21,7 @@ The hash is computed over a *serialisation* of each path: a dump of
|
||||||
the file system tree rooted at the path. This allows directories and
|
the file system tree rooted at the path. This allows directories and
|
||||||
symlinks to be hashed as well as regular files. The dump is in the
|
symlinks to be hashed as well as regular files. The dump is in the
|
||||||
*NAR format* produced by [`nix-store
|
*NAR format* produced by [`nix-store
|
||||||
--dump`](nix-store.md#operation---dump). Thus, `nix-hash path`
|
--dump`](@docroot@/command-ref/nix-store/dump.md). Thus, `nix-hash path`
|
||||||
yields the same cryptographic hash as `nix-store --dump path |
|
yields the same cryptographic hash as `nix-store --dump path |
|
||||||
md5sum`.
|
md5sum`.
|
||||||
|
|
||||||
|
|
@ -35,11 +33,23 @@ md5sum`.
|
||||||
The result is identical to that produced by the GNU commands
|
The result is identical to that produced by the GNU commands
|
||||||
`md5sum` and `sha1sum`.
|
`md5sum` and `sha1sum`.
|
||||||
|
|
||||||
|
- `--base16`\
|
||||||
|
Print the hash in a hexadecimal representation (default).
|
||||||
|
|
||||||
- `--base32`\
|
- `--base32`\
|
||||||
Print the hash in a base-32 representation rather than hexadecimal.
|
Print the hash in a base-32 representation rather than hexadecimal.
|
||||||
This base-32 representation is more compact and can be used in Nix
|
This base-32 representation is more compact and can be used in Nix
|
||||||
expressions (such as in calls to `fetchurl`).
|
expressions (such as in calls to `fetchurl`).
|
||||||
|
|
||||||
|
- `--base64`\
|
||||||
|
Similar to --base32, but print the hash in a base-64 representation,
|
||||||
|
which is more compact than the base-32 one.
|
||||||
|
|
||||||
|
- `--sri`\
|
||||||
|
Print the hash in SRI format with base-64 encoding.
|
||||||
|
The type of hash algorithm will be prepended to the hash string,
|
||||||
|
followed by a hyphen (-) and the base-64 hash body.
|
||||||
|
|
||||||
- `--truncate`\
|
- `--truncate`\
|
||||||
Truncate hashes longer than 160 bits (such as SHA-256) to 160 bits.
|
Truncate hashes longer than 160 bits (such as SHA-256) to 160 bits.
|
||||||
|
|
||||||
|
|
@ -55,6 +65,14 @@ md5sum`.
|
||||||
Don’t hash anything, but convert the hexadecimal hash representation
|
Don’t hash anything, but convert the hexadecimal hash representation
|
||||||
*hash* to base-32.
|
*hash* to base-32.
|
||||||
|
|
||||||
|
- `--to-base64`\
|
||||||
|
Don’t hash anything, but convert the hexadecimal hash representation
|
||||||
|
*hash* to base-64.
|
||||||
|
|
||||||
|
- `--to-sri`\
|
||||||
|
Don’t hash anything, but convert the hexadecimal hash representation
|
||||||
|
*hash* to SRI.
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
Computing the same hash as `nix-prefetch-url`:
|
Computing the same hash as `nix-prefetch-url`:
|
||||||
|
|
@ -81,9 +99,18 @@ $ nix-store --dump test/ | md5sum (for comparison)
|
||||||
$ nix-hash --type sha1 test/
|
$ nix-hash --type sha1 test/
|
||||||
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
||||||
|
|
||||||
|
$ nix-hash --type sha1 --base16 test/
|
||||||
|
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
||||||
|
|
||||||
$ nix-hash --type sha1 --base32 test/
|
$ nix-hash --type sha1 --base32 test/
|
||||||
nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
|
nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
|
||||||
|
|
||||||
|
$ nix-hash --type sha1 --base64 test/
|
||||||
|
5P2Lpfe76upazon+ECVVNs1g2rY=
|
||||||
|
|
||||||
|
$ nix-hash --type sha1 --sri test/
|
||||||
|
sha1-5P2Lpfe76upazon+ECVVNs1g2rY=
|
||||||
|
|
||||||
$ nix-hash --type sha256 --flat test/
|
$ nix-hash --type sha256 --flat test/
|
||||||
error: reading file `test/': Is a directory
|
error: reading file `test/': Is a directory
|
||||||
|
|
||||||
|
|
@ -91,7 +118,7 @@ $ nix-hash --type sha256 --flat test/world
|
||||||
5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
|
5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
|
||||||
```
|
```
|
||||||
|
|
||||||
Converting between hexadecimal and base-32:
|
Converting between hexadecimal, base-32, base-64, and SRI:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ nix-hash --type sha1 --to-base32 e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
$ nix-hash --type sha1 --to-base32 e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
||||||
|
|
@ -99,4 +126,13 @@ nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
|
||||||
|
|
||||||
$ nix-hash --type sha1 --to-base16 nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
|
$ nix-hash --type sha1 --to-base16 nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
|
||||||
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
||||||
|
|
||||||
|
$ nix-hash --type sha1 --to-base64 e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
||||||
|
5P2Lpfe76upazon+ECVVNs1g2rY=
|
||||||
|
|
||||||
|
$ nix-hash --type sha1 --to-sri nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
|
||||||
|
sha1-5P2Lpfe76upazon+ECVVNs1g2rY=
|
||||||
|
|
||||||
|
$ nix-hash --to-base16 sha1-5P2Lpfe76upazon+ECVVNs1g2rY=
|
||||||
|
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -76,7 +76,9 @@ standard input.
|
||||||
this option is not enabled, there may be uninstantiated store paths
|
this option is not enabled, there may be uninstantiated store paths
|
||||||
in the final output.
|
in the final output.
|
||||||
|
|
||||||
<!-- end list -->
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -101,7 +101,7 @@ All options not listed here are passed to `nix-store
|
||||||
When a `--pure` shell is started, keep the listed environment
|
When a `--pure` shell is started, keep the listed environment
|
||||||
variables.
|
variables.
|
||||||
|
|
||||||
The following common options are supported:
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
|
|
||||||
|
|
@ -110,6 +110,8 @@ The following common options are supported:
|
||||||
`bash` found in `<nixpkgs>`, falling back to the `bash` found in
|
`bash` found in `<nixpkgs>`, falling back to the `bash` found in
|
||||||
`PATH` if not found.
|
`PATH` if not found.
|
||||||
|
|
||||||
|
{{#include ./env-common.md}}
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
To build the dependencies of the package Pan, and start an interactive
|
To build the dependencies of the package Pan, and start an interactive
|
||||||
|
|
|
||||||
|
|
@ -13,833 +13,35 @@
|
||||||
The command `nix-store` performs primitive operations on the Nix store.
|
The command `nix-store` performs primitive operations on the Nix store.
|
||||||
You generally do not need to run this command manually.
|
You generally do not need to run this command manually.
|
||||||
|
|
||||||
`nix-store` takes exactly one *operation* flag which indicates the
|
`nix-store` takes exactly one *operation* flag which indicates the subcommand to be performed. The following operations are available:
|
||||||
subcommand to be performed. These are documented below.
|
|
||||||
|
- [`--realise`](./nix-store/realise.md)
|
||||||
# Common options
|
- [`--serve`](./nix-store/serve.md)
|
||||||
|
- [`--gc`](./nix-store/gc.md)
|
||||||
This section lists the options that are common to all operations. These
|
- [`--delete`](./nix-store/delete.md)
|
||||||
options are allowed for every subcommand, though they may not always
|
- [`--query`](./nix-store/query.md)
|
||||||
have an effect.
|
- [`--add`](./nix-store/add.md)
|
||||||
|
- [`--add-fixed`](./nix-store/add-fixed.md)
|
||||||
- <span id="opt-add-root">[`--add-root`](#opt-add-root)</span> *path*
|
- [`--verify`](./nix-store/verify.md)
|
||||||
|
- [`--verify-path`](./nix-store/verify-path.md)
|
||||||
Causes the result of a realisation (`--realise` and
|
- [`--repair-path`](./nix-store/repair-path.md)
|
||||||
`--force-realise`) to be registered as a root of the garbage
|
- [`--dump`](./nix-store/dump.md)
|
||||||
collector. *path* will be created as a symlink to the resulting
|
- [`--restore`](./nix-store/restore.md)
|
||||||
store path. In addition, a uniquely named symlink to *path* will
|
- [`--export`](./nix-store/export.md)
|
||||||
be created in `/nix/var/nix/gcroots/auto/`. For instance,
|
- [`--import`](./nix-store/import.md)
|
||||||
|
- [`--optimise`](./nix-store/optimise.md)
|
||||||
```console
|
- [`--read-log`](./nix-store/read-log.md)
|
||||||
$ nix-store --add-root /home/eelco/bla/result -r ...
|
- [`--dump-db`](./nix-store/dump-db.md)
|
||||||
|
- [`--load-db`](./nix-store/load-db.md)
|
||||||
$ ls -l /nix/var/nix/gcroots/auto
|
- [`--print-env`](./nix-store/print-env.md)
|
||||||
lrwxrwxrwx 1 ... 2005-03-13 21:10 dn54lcypm8f8... -> /home/eelco/bla/result
|
- [`--generate-binary-cache-key`](./nix-store/generate-binary-cache-key.md)
|
||||||
|
|
||||||
$ ls -l /home/eelco/bla/result
|
These pages can be viewed offline:
|
||||||
lrwxrwxrwx 1 ... 2005-03-13 21:10 /home/eelco/bla/result -> /nix/store/1r11343n6qd4...-f-spot-0.0.10
|
|
||||||
```
|
- `man nix-store-<operation>`.
|
||||||
|
|
||||||
Thus, when `/home/eelco/bla/result` is removed, the GC root in the
|
Example: `man nix-store-realise`
|
||||||
`auto` directory becomes a dangling symlink and will be ignored by
|
|
||||||
the collector.
|
- `nix-store --help --<operation>`
|
||||||
|
|
||||||
> **Warning**
|
Example: `nix-store --help --realise`
|
||||||
>
|
|
||||||
> Note that it is not possible to move or rename GC roots, since
|
|
||||||
> the symlink in the `auto` directory will still point to the old
|
|
||||||
> location.
|
|
||||||
|
|
||||||
If there are multiple results, then multiple symlinks will be
|
|
||||||
created by sequentially numbering symlinks beyond the first one
|
|
||||||
(e.g., `foo`, `foo-2`, `foo-3`, and so on).
|
|
||||||
|
|
||||||
# Operation `--realise`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` {`--realise` | `-r`} *paths…* [`--dry-run`]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--realise` essentially “builds” the specified store
|
|
||||||
paths. Realisation is a somewhat overloaded term:
|
|
||||||
|
|
||||||
- If the store path is a *derivation*, realisation ensures that the
|
|
||||||
output paths of the derivation are [valid] (i.e.,
|
|
||||||
the output path and its closure exist in the file system). This
|
|
||||||
can be done in several ways. First, it is possible that the
|
|
||||||
outputs are already valid, in which case we are done
|
|
||||||
immediately. Otherwise, there may be [substitutes]
|
|
||||||
that produce the outputs (e.g., by downloading them). Finally, the
|
|
||||||
outputs can be produced by running the build task described
|
|
||||||
by the derivation.
|
|
||||||
|
|
||||||
- If the store path is not a derivation, realisation ensures that the
|
|
||||||
specified path is valid (i.e., it and its closure exist in the file
|
|
||||||
system). If the path is already valid, we are done immediately.
|
|
||||||
Otherwise, the path and any missing paths in its closure may be
|
|
||||||
produced through substitutes. If there are no (successful)
|
|
||||||
substitutes, realisation fails.
|
|
||||||
|
|
||||||
[valid]: ../glossary.md#gloss-validity
|
|
||||||
[substitutes]: ../glossary.md#gloss-substitute
|
|
||||||
|
|
||||||
The output path of each derivation is printed on standard output. (For
|
|
||||||
non-derivations argument, the argument itself is printed.)
|
|
||||||
|
|
||||||
The following flags are available:
|
|
||||||
|
|
||||||
- `--dry-run`\
|
|
||||||
Print on standard error a description of what packages would be
|
|
||||||
built or downloaded, without actually performing the operation.
|
|
||||||
|
|
||||||
- `--ignore-unknown`\
|
|
||||||
If a non-derivation path does not have a substitute, then silently
|
|
||||||
ignore it.
|
|
||||||
|
|
||||||
- `--check`\
|
|
||||||
This option allows you to check whether a derivation is
|
|
||||||
deterministic. It rebuilds the specified derivation and checks
|
|
||||||
whether the result is bitwise-identical with the existing outputs,
|
|
||||||
printing an error if that’s not the case. The outputs of the
|
|
||||||
specified derivation must already exist. When used with `-K`, if an
|
|
||||||
output path is not identical to the corresponding output from the
|
|
||||||
previous build, the new output path is left in
|
|
||||||
`/nix/store/name.check.`
|
|
||||||
|
|
||||||
Special exit codes:
|
|
||||||
|
|
||||||
- `100`\
|
|
||||||
Generic build failure, the builder process returned with a non-zero
|
|
||||||
exit code.
|
|
||||||
|
|
||||||
- `101`\
|
|
||||||
Build timeout, the build was aborted because it did not complete
|
|
||||||
within the specified `timeout`.
|
|
||||||
|
|
||||||
- `102`\
|
|
||||||
Hash mismatch, the build output was rejected because it does not
|
|
||||||
match the [`outputHash` attribute of the
|
|
||||||
derivation](../language/advanced-attributes.md).
|
|
||||||
|
|
||||||
- `104`\
|
|
||||||
Not deterministic, the build succeeded in check mode but the
|
|
||||||
resulting output is not binary reproducible.
|
|
||||||
|
|
||||||
With the `--keep-going` flag it's possible for multiple failures to
|
|
||||||
occur, in this case the 1xx status codes are or combined using binary
|
|
||||||
or.
|
|
||||||
|
|
||||||
1100100
|
|
||||||
^^^^
|
|
||||||
|||`- timeout
|
|
||||||
||`-- output hash mismatch
|
|
||||||
|`--- build failure
|
|
||||||
`---- not deterministic
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
This operation is typically used to build [store derivation]s produced by
|
|
||||||
[`nix-instantiate`](./nix-instantiate.md):
|
|
||||||
|
|
||||||
[store derivation]: ../glossary.md#gloss-store-derivation
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -r $(nix-instantiate ./test.nix)
|
|
||||||
/nix/store/31axcgrlbfsxzmfff1gyj1bf62hvkby2-aterm-2.3.1
|
|
||||||
```
|
|
||||||
|
|
||||||
This is essentially what [`nix-build`](nix-build.md) does.
|
|
||||||
|
|
||||||
To test whether a previously-built derivation is deterministic:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-build '<nixpkgs>' -A hello --check -K
|
|
||||||
```
|
|
||||||
|
|
||||||
Use [`--read-log`](#operation---read-log) to show the stderr and stdout of a build:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --read-log $(nix-instantiate ./test.nix)
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--serve`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--serve` [`--write`]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--serve` provides access to the Nix store over stdin and
|
|
||||||
stdout, and is intended to be used as a means of providing Nix store
|
|
||||||
access to a restricted ssh user.
|
|
||||||
|
|
||||||
The following flags are available:
|
|
||||||
|
|
||||||
- `--write`\
|
|
||||||
Allow the connected client to request the realization of
|
|
||||||
derivations. In effect, this can be used to make the host act as a
|
|
||||||
remote builder.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
To turn a host into a build server, the `authorized_keys` file can be
|
|
||||||
used to provide build access to a given SSH public key:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ cat <<EOF >>/root/.ssh/authorized_keys
|
|
||||||
command="nice -n20 nix-store --serve --write" ssh-rsa AAAAB3NzaC1yc2EAAAA...
|
|
||||||
EOF
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--gc`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--gc` [`--print-roots` | `--print-live` | `--print-dead`] [`--max-freed` *bytes*]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
Without additional flags, the operation `--gc` performs a garbage
|
|
||||||
collection on the Nix store. That is, all paths in the Nix store not
|
|
||||||
reachable via file system references from a set of “roots”, are deleted.
|
|
||||||
|
|
||||||
The following suboperations may be specified:
|
|
||||||
|
|
||||||
- `--print-roots`\
|
|
||||||
This operation prints on standard output the set of roots used by
|
|
||||||
the garbage collector.
|
|
||||||
|
|
||||||
- `--print-live`\
|
|
||||||
This operation prints on standard output the set of “live” store
|
|
||||||
paths, which are all the store paths reachable from the roots. Live
|
|
||||||
paths should never be deleted, since that would break consistency —
|
|
||||||
it would become possible that applications are installed that
|
|
||||||
reference things that are no longer present in the store.
|
|
||||||
|
|
||||||
- `--print-dead`\
|
|
||||||
This operation prints out on standard output the set of “dead” store
|
|
||||||
paths, which is just the opposite of the set of live paths: any path
|
|
||||||
in the store that is not live (with respect to the roots) is dead.
|
|
||||||
|
|
||||||
By default, all unreachable paths are deleted. The following options
|
|
||||||
control what gets deleted and in what order:
|
|
||||||
|
|
||||||
- `--max-freed` *bytes*\
|
|
||||||
Keep deleting paths until at least *bytes* bytes have been deleted,
|
|
||||||
then stop. The argument *bytes* can be followed by the
|
|
||||||
multiplicative suffix `K`, `M`, `G` or `T`, denoting KiB, MiB, GiB
|
|
||||||
or TiB units.
|
|
||||||
|
|
||||||
The behaviour of the collector is also influenced by the
|
|
||||||
`keep-outputs` and `keep-derivations` settings in the Nix
|
|
||||||
configuration file.
|
|
||||||
|
|
||||||
By default, the collector prints the total number of freed bytes when it
|
|
||||||
finishes (or when it is interrupted). With `--print-dead`, it prints the
|
|
||||||
number of bytes that would be freed.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
To delete all unreachable paths, just do:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --gc
|
|
||||||
deleting `/nix/store/kq82idx6g0nyzsp2s14gfsc38npai7lf-cairo-1.0.4.tar.gz.drv'
|
|
||||||
...
|
|
||||||
8825586 bytes freed (8.42 MiB)
|
|
||||||
```
|
|
||||||
|
|
||||||
To delete at least 100 MiBs of unreachable paths:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --gc --max-freed $((100 * 1024 * 1024))
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--delete`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--delete` [`--ignore-liveness`] *paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--delete` deletes the store paths *paths* from the Nix
|
|
||||||
store, but only if it is safe to do so; that is, when the path is not
|
|
||||||
reachable from a root of the garbage collector. This means that you can
|
|
||||||
only delete paths that would also be deleted by `nix-store --gc`. Thus,
|
|
||||||
`--delete` is a more targeted version of `--gc`.
|
|
||||||
|
|
||||||
With the option `--ignore-liveness`, reachability from the roots is
|
|
||||||
ignored. However, the path still won’t be deleted if there are other
|
|
||||||
paths in the store that refer to it (i.e., depend on it).
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --delete /nix/store/zq0h41l75vlb4z45kzgjjmsjxvcv1qk7-mesa-6.4
|
|
||||||
0 bytes freed (0.00 MiB)
|
|
||||||
error: cannot delete path `/nix/store/zq0h41l75vlb4z45kzgjjmsjxvcv1qk7-mesa-6.4' since it is still alive
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--query`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` {`--query` | `-q`}
|
|
||||||
{`--outputs` | `--requisites` | `-R` | `--references` |
|
|
||||||
`--referrers` | `--referrers-closure` | `--deriver` | `-d` |
|
|
||||||
`--graph` | `--tree` | `--binding` *name* | `-b` *name* | `--hash` |
|
|
||||||
`--size` | `--roots`}
|
|
||||||
[`--use-output`] [`-u`] [`--force-realise`] [`-f`]
|
|
||||||
*paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--query` displays information about [store path]s.
|
|
||||||
The queries are described below. At most one query can be
|
|
||||||
specified. The default query is `--outputs`.
|
|
||||||
|
|
||||||
The paths *paths* may also be symlinks from outside of the Nix store, to
|
|
||||||
the Nix store. In that case, the query is applied to the target of the
|
|
||||||
symlink.
|
|
||||||
|
|
||||||
## Common query options
|
|
||||||
|
|
||||||
- `--use-output`; `-u`\
|
|
||||||
For each argument to the query that is a [store derivation], apply the
|
|
||||||
query to the output path of the derivation instead.
|
|
||||||
|
|
||||||
- `--force-realise`; `-f`\
|
|
||||||
Realise each argument to the query first (see [`nix-store
|
|
||||||
--realise`](#operation---realise)).
|
|
||||||
|
|
||||||
## Queries
|
|
||||||
|
|
||||||
- `--outputs`\
|
|
||||||
Prints out the [output path]s of the store
|
|
||||||
derivations *paths*. These are the paths that will be produced when
|
|
||||||
the derivation is built.
|
|
||||||
|
|
||||||
- `--requisites`; `-R`\
|
|
||||||
Prints out the [closure] of the given *paths*.
|
|
||||||
|
|
||||||
This query has one option:
|
|
||||||
|
|
||||||
- `--include-outputs`
|
|
||||||
Also include the existing output paths of [store derivation]s,
|
|
||||||
and their closures.
|
|
||||||
|
|
||||||
This query can be used to implement various kinds of deployment. A
|
|
||||||
*source deployment* is obtained by distributing the closure of a
|
|
||||||
store derivation. A *binary deployment* is obtained by distributing
|
|
||||||
the closure of an output path. A *cache deployment* (combined
|
|
||||||
source/binary deployment, including binaries of build-time-only
|
|
||||||
dependencies) is obtained by distributing the closure of a store
|
|
||||||
derivation and specifying the option `--include-outputs`.
|
|
||||||
|
|
||||||
- `--references`\
|
|
||||||
Prints the set of [references]s of the store paths
|
|
||||||
*paths*, that is, their immediate dependencies. (For *all*
|
|
||||||
dependencies, use `--requisites`.)
|
|
||||||
|
|
||||||
[reference]: ../glossary.md#gloss-reference
|
|
||||||
|
|
||||||
- `--referrers`\
|
|
||||||
Prints the set of *referrers* of the store paths *paths*, that is,
|
|
||||||
the store paths currently existing in the Nix store that refer to
|
|
||||||
one of *paths*. Note that contrary to the references, the set of
|
|
||||||
referrers is not constant; it can change as store paths are added or
|
|
||||||
removed.
|
|
||||||
|
|
||||||
- `--referrers-closure`\
|
|
||||||
Prints the closure of the set of store paths *paths* under the
|
|
||||||
referrers relation; that is, all store paths that directly or
|
|
||||||
indirectly refer to one of *paths*. These are all the path currently
|
|
||||||
in the Nix store that are dependent on *paths*.
|
|
||||||
|
|
||||||
- `--deriver`; `-d`\
|
|
||||||
Prints the [deriver] of the store paths *paths*. If
|
|
||||||
the path has no deriver (e.g., if it is a source file), or if the
|
|
||||||
deriver is not known (e.g., in the case of a binary-only
|
|
||||||
deployment), the string `unknown-deriver` is printed.
|
|
||||||
|
|
||||||
[deriver]: ../glossary.md#gloss-deriver
|
|
||||||
|
|
||||||
- `--graph`\
|
|
||||||
Prints the references graph of the store paths *paths* in the format
|
|
||||||
of the `dot` tool of AT\&T's [Graphviz
|
|
||||||
package](http://www.graphviz.org/). This can be used to visualise
|
|
||||||
dependency graphs. To obtain a build-time dependency graph, apply
|
|
||||||
this to a store derivation. To obtain a runtime dependency graph,
|
|
||||||
apply it to an output path.
|
|
||||||
|
|
||||||
- `--tree`\
|
|
||||||
Prints the references graph of the store paths *paths* as a nested
|
|
||||||
ASCII tree. References are ordered by descending closure size; this
|
|
||||||
tends to flatten the tree, making it more readable. The query only
|
|
||||||
recurses into a store path when it is first encountered; this
|
|
||||||
prevents a blowup of the tree representation of the graph.
|
|
||||||
|
|
||||||
- `--graphml`\
|
|
||||||
Prints the references graph of the store paths *paths* in the
|
|
||||||
[GraphML](http://graphml.graphdrawing.org/) file format. This can be
|
|
||||||
used to visualise dependency graphs. To obtain a build-time
|
|
||||||
dependency graph, apply this to a [store derivation]. To obtain a
|
|
||||||
runtime dependency graph, apply it to an output path.
|
|
||||||
|
|
||||||
- `--binding` *name*; `-b` *name*\
|
|
||||||
Prints the value of the attribute *name* (i.e., environment
|
|
||||||
variable) of the [store derivation]s *paths*. It is an error for a
|
|
||||||
derivation to not have the specified attribute.
|
|
||||||
|
|
||||||
- `--hash`\
|
|
||||||
Prints the SHA-256 hash of the contents of the store paths *paths*
|
|
||||||
(that is, the hash of the output of `nix-store --dump` on the given
|
|
||||||
paths). Since the hash is stored in the Nix database, this is a fast
|
|
||||||
operation.
|
|
||||||
|
|
||||||
- `--size`\
|
|
||||||
Prints the size in bytes of the contents of the store paths *paths*
|
|
||||||
— to be precise, the size of the output of `nix-store --dump` on
|
|
||||||
the given paths. Note that the actual disk space required by the
|
|
||||||
store paths may be higher, especially on filesystems with large
|
|
||||||
cluster sizes.
|
|
||||||
|
|
||||||
- `--roots`\
|
|
||||||
Prints the garbage collector roots that point, directly or
|
|
||||||
indirectly, at the store paths *paths*.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
Print the closure (runtime dependencies) of the `svn` program in the
|
|
||||||
current user environment:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -qR $(which svn)
|
|
||||||
/nix/store/5mbglq5ldqld8sj57273aljwkfvj22mc-subversion-1.1.4
|
|
||||||
/nix/store/9lz9yc6zgmc0vlqmn2ipcpkjlmbi51vv-glibc-2.3.4
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Print the build-time dependencies of `svn`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -qR $(nix-store -qd $(which svn))
|
|
||||||
/nix/store/02iizgn86m42q905rddvg4ja975bk2i4-grep-2.5.1.tar.bz2.drv
|
|
||||||
/nix/store/07a2bzxmzwz5hp58nf03pahrv2ygwgs3-gcc-wrapper.sh
|
|
||||||
/nix/store/0ma7c9wsbaxahwwl04gbw3fcd806ski4-glibc-2.3.4.drv
|
|
||||||
... lots of other paths ...
|
|
||||||
```
|
|
||||||
|
|
||||||
The difference with the previous example is that we ask the closure of
|
|
||||||
the derivation (`-qd`), not the closure of the output path that contains
|
|
||||||
`svn`.
|
|
||||||
|
|
||||||
Show the build-time dependencies as a tree:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -q --tree $(nix-store -qd $(which svn))
|
|
||||||
/nix/store/7i5082kfb6yjbqdbiwdhhza0am2xvh6c-subversion-1.1.4.drv
|
|
||||||
+---/nix/store/d8afh10z72n8l1cr5w42366abiblgn54-builder.sh
|
|
||||||
+---/nix/store/fmzxmpjx2lh849ph0l36snfj9zdibw67-bash-3.0.drv
|
|
||||||
| +---/nix/store/570hmhmx3v57605cqg9yfvvyh0nnb8k8-bash
|
|
||||||
| +---/nix/store/p3srsbd8dx44v2pg6nbnszab5mcwx03v-builder.sh
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Show all paths that depend on the same OpenSSL library as `svn`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -q --referrers $(nix-store -q --binding openssl $(nix-store -qd $(which svn)))
|
|
||||||
/nix/store/23ny9l9wixx21632y2wi4p585qhva1q8-sylpheed-1.0.0
|
|
||||||
/nix/store/5mbglq5ldqld8sj57273aljwkfvj22mc-subversion-1.1.4
|
|
||||||
/nix/store/dpmvp969yhdqs7lm2r1a3gng7pyq6vy4-subversion-1.1.3
|
|
||||||
/nix/store/l51240xqsgg8a7yrbqdx1rfzyv6l26fx-lynx-2.8.5
|
|
||||||
```
|
|
||||||
|
|
||||||
Show all paths that directly or indirectly depend on the Glibc (C
|
|
||||||
library) used by `svn`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -q --referrers-closure $(ldd $(which svn) | grep /libc.so | awk '{print $3}')
|
|
||||||
/nix/store/034a6h4vpz9kds5r6kzb9lhh81mscw43-libgnomeprintui-2.8.2
|
|
||||||
/nix/store/15l3yi0d45prm7a82pcrknxdh6nzmxza-gawk-3.1.4
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that `ldd` is a command that prints out the dynamic libraries used
|
|
||||||
by an ELF executable.
|
|
||||||
|
|
||||||
Make a picture of the runtime dependency graph of the current user
|
|
||||||
environment:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -q --graph ~/.nix-profile | dot -Tps > graph.ps
|
|
||||||
$ gv graph.ps
|
|
||||||
```
|
|
||||||
|
|
||||||
Show every garbage collector root that points to a store path that
|
|
||||||
depends on `svn`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -q --roots $(which svn)
|
|
||||||
/nix/var/nix/profiles/default-81-link
|
|
||||||
/nix/var/nix/profiles/default-82-link
|
|
||||||
/nix/var/nix/profiles/per-user/eelco/profile-97-link
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--add`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--add` *paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--add` adds the specified paths to the Nix store. It
|
|
||||||
prints the resulting paths in the Nix store on standard output.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --add ./foo.c
|
|
||||||
/nix/store/m7lrha58ph6rcnv109yzx1nk1cj7k7zf-foo.c
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--add-fixed`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--add-fixed` [`--recursive`] *algorithm* *paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--add-fixed` adds the specified paths to the Nix store.
|
|
||||||
Unlike `--add` paths are registered using the specified hashing
|
|
||||||
algorithm, resulting in the same output path as a fixed-output
|
|
||||||
derivation. This can be used for sources that are not available from a
|
|
||||||
public url or broke since the download expression was written.
|
|
||||||
|
|
||||||
This operation has the following options:
|
|
||||||
|
|
||||||
- `--recursive`\
|
|
||||||
Use recursive instead of flat hashing mode, used when adding
|
|
||||||
directories to the store.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --add-fixed sha256 ./hello-2.10.tar.gz
|
|
||||||
/nix/store/3x7dwzq014bblazs7kq20p9hyzz0qh8g-hello-2.10.tar.gz
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--verify`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--verify` [`--check-contents`] [`--repair`]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--verify` verifies the internal consistency of the Nix
|
|
||||||
database, and the consistency between the Nix database and the Nix
|
|
||||||
store. Any inconsistencies encountered are automatically repaired.
|
|
||||||
Inconsistencies are generally the result of the Nix store or database
|
|
||||||
being modified by non-Nix tools, or of bugs in Nix itself.
|
|
||||||
|
|
||||||
This operation has the following options:
|
|
||||||
|
|
||||||
- `--check-contents`\
|
|
||||||
Checks that the contents of every valid store path has not been
|
|
||||||
altered by computing a SHA-256 hash of the contents and comparing it
|
|
||||||
with the hash stored in the Nix database at build time. Paths that
|
|
||||||
have been modified are printed out. For large stores,
|
|
||||||
`--check-contents` is obviously quite slow.
|
|
||||||
|
|
||||||
- `--repair`\
|
|
||||||
If any valid path is missing from the store, or (if
|
|
||||||
`--check-contents` is given) the contents of a valid path has been
|
|
||||||
modified, then try to repair the path by redownloading it. See
|
|
||||||
`nix-store --repair-path` for details.
|
|
||||||
|
|
||||||
# Operation `--verify-path`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--verify-path` *paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--verify-path` compares the contents of the given store
|
|
||||||
paths to their cryptographic hashes stored in Nix’s database. For every
|
|
||||||
changed path, it prints a warning message. The exit status is 0 if no
|
|
||||||
path has changed, and 1 otherwise.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
To verify the integrity of the `svn` command and all its dependencies:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --verify-path $(nix-store -qR $(which svn))
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--repair-path`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--repair-path` *paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--repair-path` attempts to “repair” the specified paths
|
|
||||||
by redownloading them using the available substituters. If no
|
|
||||||
substitutes are available, then repair is not possible.
|
|
||||||
|
|
||||||
> **Warning**
|
|
||||||
>
|
|
||||||
> During repair, there is a very small time window during which the old
|
|
||||||
> path (if it exists) is moved out of the way and replaced with the new
|
|
||||||
> path. If repair is interrupted in between, then the system may be left
|
|
||||||
> in a broken state (e.g., if the path contains a critical system
|
|
||||||
> component like the GNU C Library).
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --verify-path /nix/store/dj7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13
|
|
||||||
path `/nix/store/dj7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13' was modified!
|
|
||||||
expected hash `2db57715ae90b7e31ff1f2ecb8c12ec1cc43da920efcbe3b22763f36a1861588',
|
|
||||||
got `481c5aa5483ebc97c20457bb8bca24deea56550d3985cda0027f67fe54b808e4'
|
|
||||||
|
|
||||||
$ nix-store --repair-path /nix/store/dj7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13
|
|
||||||
fetching path `/nix/store/d7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13'...
|
|
||||||
…
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--dump`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--dump` *path*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--dump` produces a NAR (Nix ARchive) file containing the
|
|
||||||
contents of the file system tree rooted at *path*. The archive is
|
|
||||||
written to standard output.
|
|
||||||
|
|
||||||
A NAR archive is like a TAR or Zip archive, but it contains only the
|
|
||||||
information that Nix considers important. For instance, timestamps are
|
|
||||||
elided because all files in the Nix store have their timestamp set to 1
|
|
||||||
anyway. Likewise, all permissions are left out except for the execute
|
|
||||||
bit, because all files in the Nix store have 444 or 555 permission.
|
|
||||||
|
|
||||||
Also, a NAR archive is *canonical*, meaning that “equal” paths always
|
|
||||||
produce the same NAR archive. For instance, directory entries are
|
|
||||||
always sorted so that the actual on-disk order doesn’t influence the
|
|
||||||
result. This means that the cryptographic hash of a NAR dump of a
|
|
||||||
path is usable as a fingerprint of the contents of the path. Indeed,
|
|
||||||
the hashes of store paths stored in Nix’s database (see `nix-store -q
|
|
||||||
--hash`) are SHA-256 hashes of the NAR dump of each store path.
|
|
||||||
|
|
||||||
NAR archives support filenames of unlimited length and 64-bit file
|
|
||||||
sizes. They can contain regular files, directories, and symbolic links,
|
|
||||||
but not other types of files (such as device nodes).
|
|
||||||
|
|
||||||
A Nix archive can be unpacked using `nix-store
|
|
||||||
--restore`.
|
|
||||||
|
|
||||||
# Operation `--restore`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--restore` *path*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--restore` unpacks a NAR archive to *path*, which must
|
|
||||||
not already exist. The archive is read from standard input.
|
|
||||||
|
|
||||||
# Operation `--export`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--export` *paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--export` writes a serialisation of the specified store
|
|
||||||
paths to standard output in a format that can be imported into another
|
|
||||||
Nix store with `nix-store --import`. This is like `nix-store
|
|
||||||
--dump`, except that the NAR archive produced by that command doesn’t
|
|
||||||
contain the necessary meta-information to allow it to be imported into
|
|
||||||
another Nix store (namely, the set of references of the path).
|
|
||||||
|
|
||||||
This command does not produce a *closure* of the specified paths, so if
|
|
||||||
a store path references other store paths that are missing in the target
|
|
||||||
Nix store, the import will fail. To copy a whole closure, do something
|
|
||||||
like:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --export $(nix-store -qR paths) > out
|
|
||||||
```
|
|
||||||
|
|
||||||
To import the whole closure again, run:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --import < out
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--import`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--import`
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--import` reads a serialisation of a set of store paths
|
|
||||||
produced by `nix-store --export` from standard input and adds those
|
|
||||||
store paths to the Nix store. Paths that already exist in the Nix store
|
|
||||||
are ignored. If a path refers to another path that doesn’t exist in the
|
|
||||||
Nix store, the import fails.
|
|
||||||
|
|
||||||
# Operation `--optimise`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--optimise`
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--optimise` reduces Nix store disk space usage by finding
|
|
||||||
identical files in the store and hard-linking them to each other. It
|
|
||||||
typically reduces the size of the store by something like 25-35%. Only
|
|
||||||
regular files and symlinks are hard-linked in this manner. Files are
|
|
||||||
considered identical when they have the same NAR archive serialisation:
|
|
||||||
that is, regular files must have the same contents and permission
|
|
||||||
(executable or non-executable), and symlinks must have the same
|
|
||||||
contents.
|
|
||||||
|
|
||||||
After completion, or when the command is interrupted, a report on the
|
|
||||||
achieved savings is printed on standard error.
|
|
||||||
|
|
||||||
Use `-vv` or `-vvv` to get some progress indication.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --optimise
|
|
||||||
hashing files in `/nix/store/qhqx7l2f1kmwihc9bnxs7rc159hsxnf3-gcc-4.1.1'
|
|
||||||
...
|
|
||||||
541838819 bytes (516.74 MiB) freed by hard-linking 54143 files;
|
|
||||||
there are 114486 files with equal contents out of 215894 files in total
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--read-log`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` {`--read-log` | `-l`} *paths…*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--read-log` prints the build log of the specified store
|
|
||||||
paths on standard output. The build log is whatever the builder of a
|
|
||||||
derivation wrote to standard output and standard error. If a store path
|
|
||||||
is not a derivation, the deriver of the store path is used.
|
|
||||||
|
|
||||||
Build logs are kept in `/nix/var/log/nix/drvs`. However, there is no
|
|
||||||
guarantee that a build log is available for any particular store path.
|
|
||||||
For instance, if the path was downloaded as a pre-built binary through a
|
|
||||||
substitute, then the log is unavailable.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store -l $(which ktorrent)
|
|
||||||
building /nix/store/dhc73pvzpnzxhdgpimsd9sw39di66ph1-ktorrent-2.2.1
|
|
||||||
unpacking sources
|
|
||||||
unpacking source archive /nix/store/p8n1jpqs27mgkjw07pb5269717nzf5f8-ktorrent-2.2.1.tar.gz
|
|
||||||
ktorrent-2.2.1/
|
|
||||||
ktorrent-2.2.1/NEWS
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--dump-db`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--dump-db` [*paths…*]
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--dump-db` writes a dump of the Nix database to standard
|
|
||||||
output. It can be loaded into an empty Nix store using `--load-db`. This
|
|
||||||
is useful for making backups and when migrating to different database
|
|
||||||
schemas.
|
|
||||||
|
|
||||||
By default, `--dump-db` will dump the entire Nix database. When one or
|
|
||||||
more store paths is passed, only the subset of the Nix database for
|
|
||||||
those store paths is dumped. As with `--export`, the user is responsible
|
|
||||||
for passing all the store paths for a closure. See `--export` for an
|
|
||||||
example.
|
|
||||||
|
|
||||||
# Operation `--load-db`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--load-db`
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--load-db` reads a dump of the Nix database created by
|
|
||||||
`--dump-db` from standard input and loads it into the Nix database.
|
|
||||||
|
|
||||||
# Operation `--print-env`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--print-env` *drvpath*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
The operation `--print-env` prints out the environment of a derivation
|
|
||||||
in a format that can be evaluated by a shell. The command line arguments
|
|
||||||
of the builder are placed in the variable `_args`.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ nix-store --print-env $(nix-instantiate '<nixpkgs>' -A firefox)
|
|
||||||
…
|
|
||||||
export src; src='/nix/store/plpj7qrwcz94z2psh6fchsi7s8yihc7k-firefox-12.0.source.tar.bz2'
|
|
||||||
export stdenv; stdenv='/nix/store/7c8asx3yfrg5dg1gzhzyq2236zfgibnn-stdenv'
|
|
||||||
export system; system='x86_64-linux'
|
|
||||||
export _args; _args='-e /nix/store/9krlzvny65gdc8s7kpb6lkx8cd02c25c-default-builder.sh'
|
|
||||||
```
|
|
||||||
|
|
||||||
# Operation `--generate-binary-cache-key`
|
|
||||||
|
|
||||||
## Synopsis
|
|
||||||
|
|
||||||
`nix-store` `--generate-binary-cache-key` *key-name* *secret-key-file* *public-key-file*
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This command generates an [Ed25519 key pair](http://ed25519.cr.yp.to/)
|
|
||||||
that can be used to create a signed binary cache. It takes three
|
|
||||||
mandatory parameters:
|
|
||||||
|
|
||||||
1. A key name, such as `cache.example.org-1`, that is used to look up
|
|
||||||
keys on the client when it verifies signatures. It can be anything,
|
|
||||||
but it’s suggested to use the host name of your cache (e.g.
|
|
||||||
`cache.example.org`) with a suffix denoting the number of the key
|
|
||||||
(to be incremented every time you need to revoke a key).
|
|
||||||
|
|
||||||
2. The file name where the secret key is to be stored.
|
|
||||||
|
|
||||||
3. The file name where the public key is to be stored.
|
|
||||||
|
|
|
||||||
35
doc/manual/src/command-ref/nix-store/add-fixed.md
Normal file
35
doc/manual/src/command-ref/nix-store/add-fixed.md
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --add-fixed` - add paths to store using given hashing algorithm
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--add-fixed` [`--recursive`] *algorithm* *paths…*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The operation `--add-fixed` adds the specified paths to the Nix store.
|
||||||
|
Unlike `--add` paths are registered using the specified hashing
|
||||||
|
algorithm, resulting in the same output path as a fixed-output
|
||||||
|
derivation. This can be used for sources that are not available from a
|
||||||
|
public url or broke since the download expression was written.
|
||||||
|
|
||||||
|
This operation has the following options:
|
||||||
|
|
||||||
|
- `--recursive`\
|
||||||
|
Use recursive instead of flat hashing mode, used when adding
|
||||||
|
directories to the store.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --add-fixed sha256 ./hello-2.10.tar.gz
|
||||||
|
/nix/store/3x7dwzq014bblazs7kq20p9hyzz0qh8g-hello-2.10.tar.gz
|
||||||
|
```
|
||||||
|
|
||||||
25
doc/manual/src/command-ref/nix-store/add.md
Normal file
25
doc/manual/src/command-ref/nix-store/add.md
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --add` - add paths to Nix store
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--add` *paths…*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--add` adds the specified paths to the Nix store. It
|
||||||
|
prints the resulting paths in the Nix store on standard output.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Example
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --add ./foo.c
|
||||||
|
/nix/store/m7lrha58ph6rcnv109yzx1nk1cj7k7zf-foo.c
|
||||||
|
```
|
||||||
33
doc/manual/src/command-ref/nix-store/delete.md
Normal file
33
doc/manual/src/command-ref/nix-store/delete.md
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --delete` - delete store paths
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--delete` [`--ignore-liveness`] *paths…*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--delete` deletes the store paths *paths* from the Nix
|
||||||
|
store, but only if it is safe to do so; that is, when the path is not
|
||||||
|
reachable from a root of the garbage collector. This means that you can
|
||||||
|
only delete paths that would also be deleted by `nix-store --gc`. Thus,
|
||||||
|
`--delete` is a more targeted version of `--gc`.
|
||||||
|
|
||||||
|
With the option `--ignore-liveness`, reachability from the roots is
|
||||||
|
ignored. However, the path still won’t be deleted if there are other
|
||||||
|
paths in the store that refer to it (i.e., depend on it).
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Example
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --delete /nix/store/zq0h41l75vlb4z45kzgjjmsjxvcv1qk7-mesa-6.4
|
||||||
|
0 bytes freed (0.00 MiB)
|
||||||
|
error: cannot delete path `/nix/store/zq0h41l75vlb4z45kzgjjmsjxvcv1qk7-mesa-6.4' since it is still alive
|
||||||
|
```
|
||||||
26
doc/manual/src/command-ref/nix-store/dump-db.md
Normal file
26
doc/manual/src/command-ref/nix-store/dump-db.md
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --dump-db` - export Nix database
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--dump-db` [*paths…*]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--dump-db` writes a dump of the Nix database to standard
|
||||||
|
output. It can be loaded into an empty Nix store using `--load-db`. This
|
||||||
|
is useful for making backups and when migrating to different database
|
||||||
|
schemas.
|
||||||
|
|
||||||
|
By default, `--dump-db` will dump the entire Nix database. When one or
|
||||||
|
more store paths is passed, only the subset of the Nix database for
|
||||||
|
those store paths is dumped. As with `--export`, the user is responsible
|
||||||
|
for passing all the store paths for a closure. See `--export` for an
|
||||||
|
example.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
40
doc/manual/src/command-ref/nix-store/dump.md
Normal file
40
doc/manual/src/command-ref/nix-store/dump.md
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --dump` - write a single path to a Nix Archive
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--dump` *path*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The operation `--dump` produces a NAR (Nix ARchive) file containing the
|
||||||
|
contents of the file system tree rooted at *path*. The archive is
|
||||||
|
written to standard output.
|
||||||
|
|
||||||
|
A NAR archive is like a TAR or Zip archive, but it contains only the
|
||||||
|
information that Nix considers important. For instance, timestamps are
|
||||||
|
elided because all files in the Nix store have their timestamp set to 0
|
||||||
|
anyway. Likewise, all permissions are left out except for the execute
|
||||||
|
bit, because all files in the Nix store have 444 or 555 permission.
|
||||||
|
|
||||||
|
Also, a NAR archive is *canonical*, meaning that “equal” paths always
|
||||||
|
produce the same NAR archive. For instance, directory entries are
|
||||||
|
always sorted so that the actual on-disk order doesn’t influence the
|
||||||
|
result. This means that the cryptographic hash of a NAR dump of a
|
||||||
|
path is usable as a fingerprint of the contents of the path. Indeed,
|
||||||
|
the hashes of store paths stored in Nix’s database (see `nix-store -q
|
||||||
|
--hash`) are SHA-256 hashes of the NAR dump of each store path.
|
||||||
|
|
||||||
|
NAR archives support filenames of unlimited length and 64-bit file
|
||||||
|
sizes. They can contain regular files, directories, and symbolic links,
|
||||||
|
but not other types of files (such as device nodes).
|
||||||
|
|
||||||
|
A Nix archive can be unpacked using `nix-store
|
||||||
|
--restore`.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
41
doc/manual/src/command-ref/nix-store/export.md
Normal file
41
doc/manual/src/command-ref/nix-store/export.md
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --export` - export store paths to a Nix Archive
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--export` *paths…*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The operation `--export` writes a serialisation of the specified store
|
||||||
|
paths to standard output in a format that can be imported into another
|
||||||
|
Nix store with `nix-store --import`. This is like `nix-store
|
||||||
|
--dump`, except that the NAR archive produced by that command doesn’t
|
||||||
|
contain the necessary meta-information to allow it to be imported into
|
||||||
|
another Nix store (namely, the set of references of the path).
|
||||||
|
|
||||||
|
This command does not produce a *closure* of the specified paths, so if
|
||||||
|
a store path references other store paths that are missing in the target
|
||||||
|
Nix store, the import will fail.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
To copy a whole closure, do something
|
||||||
|
like:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --export $(nix-store -qR paths) > out
|
||||||
|
```
|
||||||
|
|
||||||
|
To import the whole closure again, run:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --import < out
|
||||||
|
```
|
||||||
72
doc/manual/src/command-ref/nix-store/gc.md
Normal file
72
doc/manual/src/command-ref/nix-store/gc.md
Normal file
|
|
@ -0,0 +1,72 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --gc` - run garbage collection
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--gc` [`--print-roots` | `--print-live` | `--print-dead`] [`--max-freed` *bytes*]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
Without additional flags, the operation `--gc` performs a garbage
|
||||||
|
collection on the Nix store. That is, all paths in the Nix store not
|
||||||
|
reachable via file system references from a set of “roots”, are deleted.
|
||||||
|
|
||||||
|
The following suboperations may be specified:
|
||||||
|
|
||||||
|
- `--print-roots`\
|
||||||
|
This operation prints on standard output the set of roots used by
|
||||||
|
the garbage collector.
|
||||||
|
|
||||||
|
- `--print-live`\
|
||||||
|
This operation prints on standard output the set of “live” store
|
||||||
|
paths, which are all the store paths reachable from the roots. Live
|
||||||
|
paths should never be deleted, since that would break consistency —
|
||||||
|
it would become possible that applications are installed that
|
||||||
|
reference things that are no longer present in the store.
|
||||||
|
|
||||||
|
- `--print-dead`\
|
||||||
|
This operation prints out on standard output the set of “dead” store
|
||||||
|
paths, which is just the opposite of the set of live paths: any path
|
||||||
|
in the store that is not live (with respect to the roots) is dead.
|
||||||
|
|
||||||
|
By default, all unreachable paths are deleted. The following options
|
||||||
|
control what gets deleted and in what order:
|
||||||
|
|
||||||
|
- `--max-freed` *bytes*\
|
||||||
|
Keep deleting paths until at least *bytes* bytes have been deleted,
|
||||||
|
then stop. The argument *bytes* can be followed by the
|
||||||
|
multiplicative suffix `K`, `M`, `G` or `T`, denoting KiB, MiB, GiB
|
||||||
|
or TiB units.
|
||||||
|
|
||||||
|
The behaviour of the collector is also influenced by the
|
||||||
|
`keep-outputs` and `keep-derivations` settings in the Nix
|
||||||
|
configuration file.
|
||||||
|
|
||||||
|
By default, the collector prints the total number of freed bytes when it
|
||||||
|
finishes (or when it is interrupted). With `--print-dead`, it prints the
|
||||||
|
number of bytes that would be freed.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
To delete all unreachable paths, just do:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --gc
|
||||||
|
deleting `/nix/store/kq82idx6g0nyzsp2s14gfsc38npai7lf-cairo-1.0.4.tar.gz.drv'
|
||||||
|
...
|
||||||
|
8825586 bytes freed (8.42 MiB)
|
||||||
|
```
|
||||||
|
|
||||||
|
To delete at least 100 MiBs of unreachable paths:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --gc --max-freed $((100 * 1024 * 1024))
|
||||||
|
```
|
||||||
|
|
||||||
|
|
@ -0,0 +1,29 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --generate-binary-cache-key` - generate key pair to use for a binary cache
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--generate-binary-cache-key` *key-name* *secret-key-file* *public-key-file*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
This command generates an [Ed25519 key pair](http://ed25519.cr.yp.to/)
|
||||||
|
that can be used to create a signed binary cache. It takes three
|
||||||
|
mandatory parameters:
|
||||||
|
|
||||||
|
1. A key name, such as `cache.example.org-1`, that is used to look up
|
||||||
|
keys on the client when it verifies signatures. It can be anything,
|
||||||
|
but it’s suggested to use the host name of your cache (e.g.
|
||||||
|
`cache.example.org`) with a suffix denoting the number of the key
|
||||||
|
(to be incremented every time you need to revoke a key).
|
||||||
|
|
||||||
|
2. The file name where the secret key is to be stored.
|
||||||
|
|
||||||
|
3. The file name where the public key is to be stored.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
21
doc/manual/src/command-ref/nix-store/import.md
Normal file
21
doc/manual/src/command-ref/nix-store/import.md
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --import` - import Nix Archive into the store
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--import`
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--import` reads a serialisation of a set of store paths
|
||||||
|
produced by `nix-store --export` from standard input and adds those
|
||||||
|
store paths to the Nix store. Paths that already exist in the Nix store
|
||||||
|
are ignored. If a path refers to another path that doesn’t exist in the
|
||||||
|
Nix store, the import fails.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
18
doc/manual/src/command-ref/nix-store/load-db.md
Normal file
18
doc/manual/src/command-ref/nix-store/load-db.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --load-db` - import Nix database
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--load-db`
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--load-db` reads a dump of the Nix database created by
|
||||||
|
`--dump-db` from standard input and loads it into the Nix database.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
36
doc/manual/src/command-ref/nix-store/opt-common.md
Normal file
36
doc/manual/src/command-ref/nix-store/opt-common.md
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
# Options
|
||||||
|
|
||||||
|
The following options are allowed for all `nix-store` operations, but may not always have an effect.
|
||||||
|
|
||||||
|
- <span id="opt-add-root">[`--add-root`](#opt-add-root)</span> *path*
|
||||||
|
|
||||||
|
Causes the result of a realisation (`--realise` and
|
||||||
|
`--force-realise`) to be registered as a root of the garbage
|
||||||
|
collector. *path* will be created as a symlink to the resulting
|
||||||
|
store path. In addition, a uniquely named symlink to *path* will
|
||||||
|
be created in `/nix/var/nix/gcroots/auto/`. For instance,
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --add-root /home/eelco/bla/result -r ...
|
||||||
|
|
||||||
|
$ ls -l /nix/var/nix/gcroots/auto
|
||||||
|
lrwxrwxrwx 1 ... 2005-03-13 21:10 dn54lcypm8f8... -> /home/eelco/bla/result
|
||||||
|
|
||||||
|
$ ls -l /home/eelco/bla/result
|
||||||
|
lrwxrwxrwx 1 ... 2005-03-13 21:10 /home/eelco/bla/result -> /nix/store/1r11343n6qd4...-f-spot-0.0.10
|
||||||
|
```
|
||||||
|
|
||||||
|
Thus, when `/home/eelco/bla/result` is removed, the GC root in the
|
||||||
|
`auto` directory becomes a dangling symlink and will be ignored by
|
||||||
|
the collector.
|
||||||
|
|
||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> Note that it is not possible to move or rename GC roots, since
|
||||||
|
> the symlink in the `auto` directory will still point to the old
|
||||||
|
> location.
|
||||||
|
|
||||||
|
If there are multiple results, then multiple symlinks will be
|
||||||
|
created by sequentially numbering symlinks beyond the first one
|
||||||
|
(e.g., `foo`, `foo-2`, `foo-3`, and so on).
|
||||||
|
|
||||||
40
doc/manual/src/command-ref/nix-store/optimise.md
Normal file
40
doc/manual/src/command-ref/nix-store/optimise.md
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --optimise` - reduce disk space usage
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--optimise`
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The operation `--optimise` reduces Nix store disk space usage by finding
|
||||||
|
identical files in the store and hard-linking them to each other. It
|
||||||
|
typically reduces the size of the store by something like 25-35%. Only
|
||||||
|
regular files and symlinks are hard-linked in this manner. Files are
|
||||||
|
considered identical when they have the same NAR archive serialisation:
|
||||||
|
that is, regular files must have the same contents and permission
|
||||||
|
(executable or non-executable), and symlinks must have the same
|
||||||
|
contents.
|
||||||
|
|
||||||
|
After completion, or when the command is interrupted, a report on the
|
||||||
|
achieved savings is printed on standard error.
|
||||||
|
|
||||||
|
Use `-vv` or `-vvv` to get some progress indication.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --optimise
|
||||||
|
hashing files in `/nix/store/qhqx7l2f1kmwihc9bnxs7rc159hsxnf3-gcc-4.1.1'
|
||||||
|
...
|
||||||
|
541838819 bytes (516.74 MiB) freed by hard-linking 54143 files;
|
||||||
|
there are 114486 files with equal contents out of 215894 files in total
|
||||||
|
```
|
||||||
|
|
||||||
31
doc/manual/src/command-ref/nix-store/print-env.md
Normal file
31
doc/manual/src/command-ref/nix-store/print-env.md
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --print-env` - print the build environment of a derivation
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--print-env` *drvpath*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The operation `--print-env` prints out the environment of a derivation
|
||||||
|
in a format that can be evaluated by a shell. The command line arguments
|
||||||
|
of the builder are placed in the variable `_args`.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --print-env $(nix-instantiate '<nixpkgs>' -A firefox)
|
||||||
|
…
|
||||||
|
export src; src='/nix/store/plpj7qrwcz94z2psh6fchsi7s8yihc7k-firefox-12.0.source.tar.bz2'
|
||||||
|
export stdenv; stdenv='/nix/store/7c8asx3yfrg5dg1gzhzyq2236zfgibnn-stdenv'
|
||||||
|
export system; system='x86_64-linux'
|
||||||
|
export _args; _args='-e /nix/store/9krlzvny65gdc8s7kpb6lkx8cd02c25c-default-builder.sh'
|
||||||
|
```
|
||||||
|
|
||||||
220
doc/manual/src/command-ref/nix-store/query.md
Normal file
220
doc/manual/src/command-ref/nix-store/query.md
Normal file
|
|
@ -0,0 +1,220 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --query` - display information about store paths
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` {`--query` | `-q`}
|
||||||
|
{`--outputs` | `--requisites` | `-R` | `--references` |
|
||||||
|
`--referrers` | `--referrers-closure` | `--deriver` | `-d` |
|
||||||
|
`--graph` | `--tree` | `--binding` *name* | `-b` *name* | `--hash` |
|
||||||
|
`--size` | `--roots`}
|
||||||
|
[`--use-output`] [`-u`] [`--force-realise`] [`-f`]
|
||||||
|
*paths…*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--query` displays various bits of information about the
|
||||||
|
store paths . The queries are described below. At most one query can be
|
||||||
|
specified. The default query is `--outputs`.
|
||||||
|
|
||||||
|
The paths *paths* may also be symlinks from outside of the Nix store, to
|
||||||
|
the Nix store. In that case, the query is applied to the target of the
|
||||||
|
symlink.
|
||||||
|
|
||||||
|
# Common query options
|
||||||
|
|
||||||
|
- `--use-output`; `-u`\
|
||||||
|
For each argument to the query that is a [store derivation], apply the
|
||||||
|
query to the output path of the derivation instead.
|
||||||
|
|
||||||
|
- `--force-realise`; `-f`\
|
||||||
|
Realise each argument to the query first (see [`nix-store --realise`](./realise.md)).
|
||||||
|
|
||||||
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
|
# Queries
|
||||||
|
|
||||||
|
- `--outputs`\
|
||||||
|
Prints out the [output paths] of the store
|
||||||
|
derivations *paths*. These are the paths that will be produced when
|
||||||
|
the derivation is built.
|
||||||
|
|
||||||
|
[output paths]: ../../glossary.md#gloss-output-path
|
||||||
|
|
||||||
|
- `--requisites`; `-R`\
|
||||||
|
Prints out the [closure] of the store path *paths*.
|
||||||
|
|
||||||
|
[closure]: ../../glossary.md#gloss-closure
|
||||||
|
|
||||||
|
This query has one option:
|
||||||
|
|
||||||
|
- `--include-outputs`
|
||||||
|
Also include the existing output paths of [store derivation]s,
|
||||||
|
and their closures.
|
||||||
|
|
||||||
|
This query can be used to implement various kinds of deployment. A
|
||||||
|
*source deployment* is obtained by distributing the closure of a
|
||||||
|
store derivation. A *binary deployment* is obtained by distributing
|
||||||
|
the closure of an output path. A *cache deployment* (combined
|
||||||
|
source/binary deployment, including binaries of build-time-only
|
||||||
|
dependencies) is obtained by distributing the closure of a store
|
||||||
|
derivation and specifying the option `--include-outputs`.
|
||||||
|
|
||||||
|
- `--references`\
|
||||||
|
Prints the set of [references] of the store paths
|
||||||
|
*paths*, that is, their immediate dependencies. (For *all*
|
||||||
|
dependencies, use `--requisites`.)
|
||||||
|
|
||||||
|
[references]: ../../glossary.md#gloss-reference
|
||||||
|
|
||||||
|
- `--referrers`\
|
||||||
|
Prints the set of *referrers* of the store paths *paths*, that is,
|
||||||
|
the store paths currently existing in the Nix store that refer to
|
||||||
|
one of *paths*. Note that contrary to the references, the set of
|
||||||
|
referrers is not constant; it can change as store paths are added or
|
||||||
|
removed.
|
||||||
|
|
||||||
|
- `--referrers-closure`\
|
||||||
|
Prints the closure of the set of store paths *paths* under the
|
||||||
|
referrers relation; that is, all store paths that directly or
|
||||||
|
indirectly refer to one of *paths*. These are all the path currently
|
||||||
|
in the Nix store that are dependent on *paths*.
|
||||||
|
|
||||||
|
- `--deriver`; `-d`\
|
||||||
|
Prints the [deriver] of the store paths *paths*. If
|
||||||
|
the path has no deriver (e.g., if it is a source file), or if the
|
||||||
|
deriver is not known (e.g., in the case of a binary-only
|
||||||
|
deployment), the string `unknown-deriver` is printed.
|
||||||
|
|
||||||
|
[deriver]: ../../glossary.md#gloss-deriver
|
||||||
|
|
||||||
|
- `--graph`\
|
||||||
|
Prints the references graph of the store paths *paths* in the format
|
||||||
|
of the `dot` tool of AT\&T's [Graphviz
|
||||||
|
package](http://www.graphviz.org/). This can be used to visualise
|
||||||
|
dependency graphs. To obtain a build-time dependency graph, apply
|
||||||
|
this to a store derivation. To obtain a runtime dependency graph,
|
||||||
|
apply it to an output path.
|
||||||
|
|
||||||
|
- `--tree`\
|
||||||
|
Prints the references graph of the store paths *paths* as a nested
|
||||||
|
ASCII tree. References are ordered by descending closure size; this
|
||||||
|
tends to flatten the tree, making it more readable. The query only
|
||||||
|
recurses into a store path when it is first encountered; this
|
||||||
|
prevents a blowup of the tree representation of the graph.
|
||||||
|
|
||||||
|
- `--graphml`\
|
||||||
|
Prints the references graph of the store paths *paths* in the
|
||||||
|
[GraphML](http://graphml.graphdrawing.org/) file format. This can be
|
||||||
|
used to visualise dependency graphs. To obtain a build-time
|
||||||
|
dependency graph, apply this to a [store derivation]. To obtain a
|
||||||
|
runtime dependency graph, apply it to an output path.
|
||||||
|
|
||||||
|
- `--binding` *name*; `-b` *name*\
|
||||||
|
Prints the value of the attribute *name* (i.e., environment
|
||||||
|
variable) of the [store derivation]s *paths*. It is an error for a
|
||||||
|
derivation to not have the specified attribute.
|
||||||
|
|
||||||
|
- `--hash`\
|
||||||
|
Prints the SHA-256 hash of the contents of the store paths *paths*
|
||||||
|
(that is, the hash of the output of `nix-store --dump` on the given
|
||||||
|
paths). Since the hash is stored in the Nix database, this is a fast
|
||||||
|
operation.
|
||||||
|
|
||||||
|
- `--size`\
|
||||||
|
Prints the size in bytes of the contents of the store paths *paths*
|
||||||
|
— to be precise, the size of the output of `nix-store --dump` on
|
||||||
|
the given paths. Note that the actual disk space required by the
|
||||||
|
store paths may be higher, especially on filesystems with large
|
||||||
|
cluster sizes.
|
||||||
|
|
||||||
|
- `--roots`\
|
||||||
|
Prints the garbage collector roots that point, directly or
|
||||||
|
indirectly, at the store paths *paths*.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
Print the closure (runtime dependencies) of the `svn` program in the
|
||||||
|
current user environment:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -qR $(which svn)
|
||||||
|
/nix/store/5mbglq5ldqld8sj57273aljwkfvj22mc-subversion-1.1.4
|
||||||
|
/nix/store/9lz9yc6zgmc0vlqmn2ipcpkjlmbi51vv-glibc-2.3.4
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Print the build-time dependencies of `svn`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -qR $(nix-store -qd $(which svn))
|
||||||
|
/nix/store/02iizgn86m42q905rddvg4ja975bk2i4-grep-2.5.1.tar.bz2.drv
|
||||||
|
/nix/store/07a2bzxmzwz5hp58nf03pahrv2ygwgs3-gcc-wrapper.sh
|
||||||
|
/nix/store/0ma7c9wsbaxahwwl04gbw3fcd806ski4-glibc-2.3.4.drv
|
||||||
|
... lots of other paths ...
|
||||||
|
```
|
||||||
|
|
||||||
|
The difference with the previous example is that we ask the closure of
|
||||||
|
the derivation (`-qd`), not the closure of the output path that contains
|
||||||
|
`svn`.
|
||||||
|
|
||||||
|
Show the build-time dependencies as a tree:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -q --tree $(nix-store -qd $(which svn))
|
||||||
|
/nix/store/7i5082kfb6yjbqdbiwdhhza0am2xvh6c-subversion-1.1.4.drv
|
||||||
|
+---/nix/store/d8afh10z72n8l1cr5w42366abiblgn54-builder.sh
|
||||||
|
+---/nix/store/fmzxmpjx2lh849ph0l36snfj9zdibw67-bash-3.0.drv
|
||||||
|
| +---/nix/store/570hmhmx3v57605cqg9yfvvyh0nnb8k8-bash
|
||||||
|
| +---/nix/store/p3srsbd8dx44v2pg6nbnszab5mcwx03v-builder.sh
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Show all paths that depend on the same OpenSSL library as `svn`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -q --referrers $(nix-store -q --binding openssl $(nix-store -qd $(which svn)))
|
||||||
|
/nix/store/23ny9l9wixx21632y2wi4p585qhva1q8-sylpheed-1.0.0
|
||||||
|
/nix/store/5mbglq5ldqld8sj57273aljwkfvj22mc-subversion-1.1.4
|
||||||
|
/nix/store/dpmvp969yhdqs7lm2r1a3gng7pyq6vy4-subversion-1.1.3
|
||||||
|
/nix/store/l51240xqsgg8a7yrbqdx1rfzyv6l26fx-lynx-2.8.5
|
||||||
|
```
|
||||||
|
|
||||||
|
Show all paths that directly or indirectly depend on the Glibc (C
|
||||||
|
library) used by `svn`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -q --referrers-closure $(ldd $(which svn) | grep /libc.so | awk '{print $3}')
|
||||||
|
/nix/store/034a6h4vpz9kds5r6kzb9lhh81mscw43-libgnomeprintui-2.8.2
|
||||||
|
/nix/store/15l3yi0d45prm7a82pcrknxdh6nzmxza-gawk-3.1.4
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that `ldd` is a command that prints out the dynamic libraries used
|
||||||
|
by an ELF executable.
|
||||||
|
|
||||||
|
Make a picture of the runtime dependency graph of the current user
|
||||||
|
environment:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -q --graph ~/.nix-profile | dot -Tps > graph.ps
|
||||||
|
$ gv graph.ps
|
||||||
|
```
|
||||||
|
|
||||||
|
Show every garbage collector root that points to a store path that
|
||||||
|
depends on `svn`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -q --roots $(which svn)
|
||||||
|
/nix/var/nix/profiles/default-81-link
|
||||||
|
/nix/var/nix/profiles/default-82-link
|
||||||
|
/home/eelco/.local/state/nix/profiles/profile-97-link
|
||||||
|
```
|
||||||
|
|
||||||
38
doc/manual/src/command-ref/nix-store/read-log.md
Normal file
38
doc/manual/src/command-ref/nix-store/read-log.md
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --read-log` - print build log
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` {`--read-log` | `-l`} *paths…*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--read-log` prints the build log of the specified store
|
||||||
|
paths on standard output. The build log is whatever the builder of a
|
||||||
|
derivation wrote to standard output and standard error. If a store path
|
||||||
|
is not a derivation, the deriver of the store path is used.
|
||||||
|
|
||||||
|
Build logs are kept in `/nix/var/log/nix/drvs`. However, there is no
|
||||||
|
guarantee that a build log is available for any particular store path.
|
||||||
|
For instance, if the path was downloaded as a pre-built binary through a
|
||||||
|
substitute, then the log is unavailable.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Example
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -l $(which ktorrent)
|
||||||
|
building /nix/store/dhc73pvzpnzxhdgpimsd9sw39di66ph1-ktorrent-2.2.1
|
||||||
|
unpacking sources
|
||||||
|
unpacking source archive /nix/store/p8n1jpqs27mgkjw07pb5269717nzf5f8-ktorrent-2.2.1.tar.gz
|
||||||
|
ktorrent-2.2.1/
|
||||||
|
ktorrent-2.2.1/NEWS
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
118
doc/manual/src/command-ref/nix-store/realise.md
Normal file
118
doc/manual/src/command-ref/nix-store/realise.md
Normal file
|
|
@ -0,0 +1,118 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --realise` - realise specified store paths
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` {`--realise` | `-r`} *paths…* [`--dry-run`]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--realise` essentially “builds” the specified store
|
||||||
|
paths. Realisation is a somewhat overloaded term:
|
||||||
|
|
||||||
|
- If the store path is a *derivation*, realisation ensures that the
|
||||||
|
output paths of the derivation are [valid] (i.e.,
|
||||||
|
the output path and its closure exist in the file system). This
|
||||||
|
can be done in several ways. First, it is possible that the
|
||||||
|
outputs are already valid, in which case we are done
|
||||||
|
immediately. Otherwise, there may be [substitutes]
|
||||||
|
that produce the outputs (e.g., by downloading them). Finally, the
|
||||||
|
outputs can be produced by running the build task described
|
||||||
|
by the derivation.
|
||||||
|
|
||||||
|
- If the store path is not a derivation, realisation ensures that the
|
||||||
|
specified path is valid (i.e., it and its closure exist in the file
|
||||||
|
system). If the path is already valid, we are done immediately.
|
||||||
|
Otherwise, the path and any missing paths in its closure may be
|
||||||
|
produced through substitutes. If there are no (successful)
|
||||||
|
substitutes, realisation fails.
|
||||||
|
|
||||||
|
[valid]: @docroot@/glossary.md#gloss-validity
|
||||||
|
[substitutes]: @docroot@/glossary.md#gloss-substitute
|
||||||
|
|
||||||
|
The output path of each derivation is printed on standard output. (For
|
||||||
|
non-derivations argument, the argument itself is printed.)
|
||||||
|
|
||||||
|
The following flags are available:
|
||||||
|
|
||||||
|
- `--dry-run`\
|
||||||
|
Print on standard error a description of what packages would be
|
||||||
|
built or downloaded, without actually performing the operation.
|
||||||
|
|
||||||
|
- `--ignore-unknown`\
|
||||||
|
If a non-derivation path does not have a substitute, then silently
|
||||||
|
ignore it.
|
||||||
|
|
||||||
|
- `--check`\
|
||||||
|
This option allows you to check whether a derivation is
|
||||||
|
deterministic. It rebuilds the specified derivation and checks
|
||||||
|
whether the result is bitwise-identical with the existing outputs,
|
||||||
|
printing an error if that’s not the case. The outputs of the
|
||||||
|
specified derivation must already exist. When used with `-K`, if an
|
||||||
|
output path is not identical to the corresponding output from the
|
||||||
|
previous build, the new output path is left in
|
||||||
|
`/nix/store/name.check.`
|
||||||
|
|
||||||
|
Special exit codes:
|
||||||
|
|
||||||
|
- `100`\
|
||||||
|
Generic build failure, the builder process returned with a non-zero
|
||||||
|
exit code.
|
||||||
|
|
||||||
|
- `101`\
|
||||||
|
Build timeout, the build was aborted because it did not complete
|
||||||
|
within the specified `timeout`.
|
||||||
|
|
||||||
|
- `102`\
|
||||||
|
Hash mismatch, the build output was rejected because it does not
|
||||||
|
match the [`outputHash` attribute of the
|
||||||
|
derivation](@docroot@/language/advanced-attributes.md).
|
||||||
|
|
||||||
|
- `104`\
|
||||||
|
Not deterministic, the build succeeded in check mode but the
|
||||||
|
resulting output is not binary reproducible.
|
||||||
|
|
||||||
|
With the `--keep-going` flag it's possible for multiple failures to
|
||||||
|
occur, in this case the 1xx status codes are or combined using binary
|
||||||
|
or.
|
||||||
|
|
||||||
|
1100100
|
||||||
|
^^^^
|
||||||
|
|||`- timeout
|
||||||
|
||`-- output hash mismatch
|
||||||
|
|`--- build failure
|
||||||
|
`---- not deterministic
|
||||||
|
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
This operation is typically used to build [store derivation]s produced by
|
||||||
|
[`nix-instantiate`](@docroot@/command-ref/nix-instantiate.md):
|
||||||
|
|
||||||
|
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store -r $(nix-instantiate ./test.nix)
|
||||||
|
/nix/store/31axcgrlbfsxzmfff1gyj1bf62hvkby2-aterm-2.3.1
|
||||||
|
```
|
||||||
|
|
||||||
|
This is essentially what [`nix-build`](@docroot@/command-ref/nix-build.md) does.
|
||||||
|
|
||||||
|
To test whether a previously-built derivation is deterministic:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-build '<nixpkgs>' -A hello --check -K
|
||||||
|
```
|
||||||
|
|
||||||
|
Use [`nix-store --read-log`](./read-log.md) to show the stderr and stdout of a build:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --read-log $(nix-instantiate ./test.nix)
|
||||||
|
```
|
||||||
35
doc/manual/src/command-ref/nix-store/repair-path.md
Normal file
35
doc/manual/src/command-ref/nix-store/repair-path.md
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix --repair-path` - re-download path from substituter
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--repair-path` *paths…*
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--repair-path` attempts to “repair” the specified paths
|
||||||
|
by redownloading them using the available substituters. If no
|
||||||
|
substitutes are available, then repair is not possible.
|
||||||
|
|
||||||
|
> **Warning**
|
||||||
|
>
|
||||||
|
> During repair, there is a very small time window during which the old
|
||||||
|
> path (if it exists) is moved out of the way and replaced with the new
|
||||||
|
> path. If repair is interrupted in between, then the system may be left
|
||||||
|
> in a broken state (e.g., if the path contains a critical system
|
||||||
|
> component like the GNU C Library).
|
||||||
|
|
||||||
|
# Example
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --verify-path /nix/store/dj7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13
|
||||||
|
path `/nix/store/dj7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13' was modified!
|
||||||
|
expected hash `2db57715ae90b7e31ff1f2ecb8c12ec1cc43da920efcbe3b22763f36a1861588',
|
||||||
|
got `481c5aa5483ebc97c20457bb8bca24deea56550d3985cda0027f67fe54b808e4'
|
||||||
|
|
||||||
|
$ nix-store --repair-path /nix/store/dj7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13
|
||||||
|
fetching path `/nix/store/d7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13'...
|
||||||
|
…
|
||||||
|
```
|
||||||
|
|
||||||
18
doc/manual/src/command-ref/nix-store/restore.md
Normal file
18
doc/manual/src/command-ref/nix-store/restore.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --restore` - extract a Nix archive
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--restore` *path*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The operation `--restore` unpacks a NAR archive to *path*, which must
|
||||||
|
not already exist. The archive is read from standard input.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
38
doc/manual/src/command-ref/nix-store/serve.md
Normal file
38
doc/manual/src/command-ref/nix-store/serve.md
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --serve` - serve local Nix store over SSH
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--serve` [`--write`]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--serve` provides access to the Nix store over stdin and
|
||||||
|
stdout, and is intended to be used as a means of providing Nix store
|
||||||
|
access to a restricted ssh user.
|
||||||
|
|
||||||
|
The following flags are available:
|
||||||
|
|
||||||
|
- `--write`\
|
||||||
|
Allow the connected client to request the realization of
|
||||||
|
derivations. In effect, this can be used to make the host act as a
|
||||||
|
remote builder.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
# Examples
|
||||||
|
|
||||||
|
To turn a host into a build server, the `authorized_keys` file can be
|
||||||
|
used to provide build access to a given SSH public key:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ cat <<EOF >>/root/.ssh/authorized_keys
|
||||||
|
command="nice -n20 nix-store --serve --write" ssh-rsa AAAAB3NzaC1yc2EAAAA...
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
|
||||||
29
doc/manual/src/command-ref/nix-store/verify-path.md
Normal file
29
doc/manual/src/command-ref/nix-store/verify-path.md
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --verify-path` - check path contents against Nix database
|
||||||
|
|
||||||
|
## Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--verify-path` *paths…*
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
The operation `--verify-path` compares the contents of the given store
|
||||||
|
paths to their cryptographic hashes stored in Nix’s database. For every
|
||||||
|
changed path, it prints a warning message. The exit status is 0 if no
|
||||||
|
path has changed, and 1 otherwise.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
To verify the integrity of the `svn` command and all its dependencies:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ nix-store --verify-path $(nix-store -qR $(which svn))
|
||||||
|
```
|
||||||
|
|
||||||
36
doc/manual/src/command-ref/nix-store/verify.md
Normal file
36
doc/manual/src/command-ref/nix-store/verify.md
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
# Name
|
||||||
|
|
||||||
|
`nix-store --verify` - check Nix database for consistency
|
||||||
|
|
||||||
|
# Synopsis
|
||||||
|
|
||||||
|
`nix-store` `--verify` [`--check-contents`] [`--repair`]
|
||||||
|
|
||||||
|
# Description
|
||||||
|
|
||||||
|
The operation `--verify` verifies the internal consistency of the Nix
|
||||||
|
database, and the consistency between the Nix database and the Nix
|
||||||
|
store. Any inconsistencies encountered are automatically repaired.
|
||||||
|
Inconsistencies are generally the result of the Nix store or database
|
||||||
|
being modified by non-Nix tools, or of bugs in Nix itself.
|
||||||
|
|
||||||
|
This operation has the following options:
|
||||||
|
|
||||||
|
- `--check-contents`\
|
||||||
|
Checks that the contents of every valid store path has not been
|
||||||
|
altered by computing a SHA-256 hash of the contents and comparing it
|
||||||
|
with the hash stored in the Nix database at build time. Paths that
|
||||||
|
have been modified are printed out. For large stores,
|
||||||
|
`--check-contents` is obviously quite slow.
|
||||||
|
|
||||||
|
- `--repair`\
|
||||||
|
If any valid path is missing from the store, or (if
|
||||||
|
`--check-contents` is given) the contents of a valid path has been
|
||||||
|
modified, then try to repair the path by redownloading it. See
|
||||||
|
`nix-store --repair-path` for details.
|
||||||
|
|
||||||
|
{{#include ./opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../opt-common.md}}
|
||||||
|
|
||||||
|
{{#include ../env-common.md}}
|
||||||
|
|
@ -2,13 +2,13 @@
|
||||||
|
|
||||||
Most Nix commands accept the following command-line options:
|
Most Nix commands accept the following command-line options:
|
||||||
|
|
||||||
- [`--help`]{#opt-help}\
|
- <span id="opt-help">[`--help`](#opt-help)</span>\
|
||||||
Prints out a summary of the command syntax and exits.
|
Prints out a summary of the command syntax and exits.
|
||||||
|
|
||||||
- [`--version`]{#opt-version}\
|
- <span id="opt-version">[`--version`](#opt-version)</span>\
|
||||||
Prints out the Nix version number on standard output and exits.
|
Prints out the Nix version number on standard output and exits.
|
||||||
|
|
||||||
- [`--verbose`]{#opt-verbose} / `-v`\
|
- <span id="opt-verbose">[`--verbose`](#opt-verbose)</span> / `-v`\
|
||||||
Increases the level of verbosity of diagnostic messages printed on
|
Increases the level of verbosity of diagnostic messages printed on
|
||||||
standard error. For each Nix operation, the information printed on
|
standard error. For each Nix operation, the information printed on
|
||||||
standard output is well-defined; any diagnostic information is
|
standard output is well-defined; any diagnostic information is
|
||||||
|
|
@ -37,14 +37,14 @@ Most Nix commands accept the following command-line options:
|
||||||
- 5\
|
- 5\
|
||||||
“Vomit”: print vast amounts of debug information.
|
“Vomit”: print vast amounts of debug information.
|
||||||
|
|
||||||
- [`--quiet`]{#opt-quiet}\
|
- <span id="opt-quiet">[`--quiet`](#opt-quiet)</span>\
|
||||||
Decreases the level of verbosity of diagnostic messages printed on
|
Decreases the level of verbosity of diagnostic messages printed on
|
||||||
standard error. This is the inverse option to `-v` / `--verbose`.
|
standard error. This is the inverse option to `-v` / `--verbose`.
|
||||||
|
|
||||||
This option may be specified repeatedly. See the previous verbosity
|
This option may be specified repeatedly. See the previous verbosity
|
||||||
levels list.
|
levels list.
|
||||||
|
|
||||||
- [`--log-format`]{#opt-log-format} *format*\
|
- <span id="opt-log-format">[`--log-format`](#opt-log-format)</span> *format*\
|
||||||
This option can be used to change the output of the log format, with
|
This option can be used to change the output of the log format, with
|
||||||
*format* being one of:
|
*format* being one of:
|
||||||
|
|
||||||
|
|
@ -66,14 +66,14 @@ Most Nix commands accept the following command-line options:
|
||||||
- bar-with-logs\
|
- bar-with-logs\
|
||||||
Display the raw logs, with the progress bar at the bottom.
|
Display the raw logs, with the progress bar at the bottom.
|
||||||
|
|
||||||
- [`--no-build-output`]{#opt-no-build-output} / `-Q`\
|
- <span id="opt-no-build-output">[`--no-build-output`](#opt-no-build-output)</span> / `-Q`\
|
||||||
By default, output written by builders to standard output and
|
By default, output written by builders to standard output and
|
||||||
standard error is echoed to the Nix command's standard error. This
|
standard error is echoed to the Nix command's standard error. This
|
||||||
option suppresses this behaviour. Note that the builder's standard
|
option suppresses this behaviour. Note that the builder's standard
|
||||||
output and error are always written to a log file in
|
output and error are always written to a log file in
|
||||||
`prefix/nix/var/log/nix`.
|
`prefix/nix/var/log/nix`.
|
||||||
|
|
||||||
- [`--max-jobs`]{#opt-max-jobs} / `-j` *number*\
|
- <span id="opt-max-jobs">[`--max-jobs`](#opt-max-jobs)</span> / `-j` *number*\
|
||||||
Sets the maximum number of build jobs that Nix will perform in
|
Sets the maximum number of build jobs that Nix will perform in
|
||||||
parallel to the specified number. Specify `auto` to use the number
|
parallel to the specified number. Specify `auto` to use the number
|
||||||
of CPUs in the system. The default is specified by the `max-jobs`
|
of CPUs in the system. The default is specified by the `max-jobs`
|
||||||
|
|
@ -83,7 +83,7 @@ Most Nix commands accept the following command-line options:
|
||||||
Setting it to `0` disallows building on the local machine, which is
|
Setting it to `0` disallows building on the local machine, which is
|
||||||
useful when you want builds to happen only on remote builders.
|
useful when you want builds to happen only on remote builders.
|
||||||
|
|
||||||
- [`--cores`]{#opt-cores}\
|
- <span id="opt-cores">[`--cores`](#opt-cores)</span>\
|
||||||
Sets the value of the `NIX_BUILD_CORES` environment variable in
|
Sets the value of the `NIX_BUILD_CORES` environment variable in
|
||||||
the invocation of builders. Builders can use this variable at
|
the invocation of builders. Builders can use this variable at
|
||||||
their discretion to control the maximum amount of parallelism. For
|
their discretion to control the maximum amount of parallelism. For
|
||||||
|
|
@ -94,18 +94,18 @@ Most Nix commands accept the following command-line options:
|
||||||
means that the builder should use all available CPU cores in the
|
means that the builder should use all available CPU cores in the
|
||||||
system.
|
system.
|
||||||
|
|
||||||
- [`--max-silent-time`]{#opt-max-silent-time}\
|
- <span id="opt-max-silent-time">[`--max-silent-time`](#opt-max-silent-time)</span>\
|
||||||
Sets the maximum number of seconds that a builder can go without
|
Sets the maximum number of seconds that a builder can go without
|
||||||
producing any data on standard output or standard error. The
|
producing any data on standard output or standard error. The
|
||||||
default is specified by the `max-silent-time` configuration
|
default is specified by the `max-silent-time` configuration
|
||||||
setting. `0` means no time-out.
|
setting. `0` means no time-out.
|
||||||
|
|
||||||
- [`--timeout`]{#opt-timeout}\
|
- <span id="opt-timeout">[`--timeout`](#opt-timeout)</span>\
|
||||||
Sets the maximum number of seconds that a builder can run. The
|
Sets the maximum number of seconds that a builder can run. The
|
||||||
default is specified by the `timeout` configuration setting. `0`
|
default is specified by the `timeout` configuration setting. `0`
|
||||||
means no timeout.
|
means no timeout.
|
||||||
|
|
||||||
- [`--keep-going`]{#opt-keep-going} / `-k`\
|
- <span id="opt-keep-going">[`--keep-going`](#opt-keep-going)</span> / `-k`\
|
||||||
Keep going in case of failed builds, to the greatest extent
|
Keep going in case of failed builds, to the greatest extent
|
||||||
possible. That is, if building an input of some derivation fails,
|
possible. That is, if building an input of some derivation fails,
|
||||||
Nix will still build the other inputs, but not the derivation
|
Nix will still build the other inputs, but not the derivation
|
||||||
|
|
@ -113,13 +113,13 @@ Most Nix commands accept the following command-line options:
|
||||||
for builds of substitutes), possibly killing builds in progress (in
|
for builds of substitutes), possibly killing builds in progress (in
|
||||||
case of parallel or distributed builds).
|
case of parallel or distributed builds).
|
||||||
|
|
||||||
- [`--keep-failed`]{#opt-keep-failed} / `-K`\
|
- <span id="opt-keep-failed">[`--keep-failed`](#opt-keep-failed)</span> / `-K`\
|
||||||
Specifies that in case of a build failure, the temporary directory
|
Specifies that in case of a build failure, the temporary directory
|
||||||
(usually in `/tmp`) in which the build takes place should not be
|
(usually in `/tmp`) in which the build takes place should not be
|
||||||
deleted. The path of the build directory is printed as an
|
deleted. The path of the build directory is printed as an
|
||||||
informational message.
|
informational message.
|
||||||
|
|
||||||
- [`--fallback`]{#opt-fallback}\
|
- <span id="opt-fallback">[`--fallback`](#opt-fallback)</span>\
|
||||||
Whenever Nix attempts to build a derivation for which substitutes
|
Whenever Nix attempts to build a derivation for which substitutes
|
||||||
are known for each output path, but realising the output paths
|
are known for each output path, but realising the output paths
|
||||||
through the substitutes fails, fall back on building the derivation.
|
through the substitutes fails, fall back on building the derivation.
|
||||||
|
|
@ -134,18 +134,18 @@ Most Nix commands accept the following command-line options:
|
||||||
failure in obtaining the substitutes to lead to a full build from
|
failure in obtaining the substitutes to lead to a full build from
|
||||||
source (with the related consumption of resources).
|
source (with the related consumption of resources).
|
||||||
|
|
||||||
- [`--readonly-mode`]{#opt-readonly-mode}\
|
- <span id="opt-readonly-mode">[`--readonly-mode`](#opt-readonly-mode)</span>\
|
||||||
When this option is used, no attempt is made to open the Nix
|
When this option is used, no attempt is made to open the Nix
|
||||||
database. Most Nix operations do need database access, so those
|
database. Most Nix operations do need database access, so those
|
||||||
operations will fail.
|
operations will fail.
|
||||||
|
|
||||||
- [`--arg`]{#opt-arg} *name* *value*\
|
- <span id="opt-arg">[`--arg`](#opt-arg)</span> *name* *value*\
|
||||||
This option is accepted by `nix-env`, `nix-instantiate`,
|
This option is accepted by `nix-env`, `nix-instantiate`,
|
||||||
`nix-shell` and `nix-build`. When evaluating Nix expressions, the
|
`nix-shell` and `nix-build`. When evaluating Nix expressions, the
|
||||||
expression evaluator will automatically try to call functions that
|
expression evaluator will automatically try to call functions that
|
||||||
it encounters. It can automatically call functions for which every
|
it encounters. It can automatically call functions for which every
|
||||||
argument has a [default
|
argument has a [default
|
||||||
value](../language/constructs.md#functions) (e.g.,
|
value](@docroot@/language/constructs.md#functions) (e.g.,
|
||||||
`{ argName ? defaultValue }: ...`). With `--arg`, you can also
|
`{ argName ? defaultValue }: ...`). With `--arg`, you can also
|
||||||
call functions that have arguments without a default value (or
|
call functions that have arguments without a default value (or
|
||||||
override a default value). That is, if the evaluator encounters a
|
override a default value). That is, if the evaluator encounters a
|
||||||
|
|
@ -164,26 +164,26 @@ Most Nix commands accept the following command-line options:
|
||||||
|
|
||||||
So if you call this Nix expression (e.g., when you do `nix-env -iA
|
So if you call this Nix expression (e.g., when you do `nix-env -iA
|
||||||
pkgname`), the function will be called automatically using the
|
pkgname`), the function will be called automatically using the
|
||||||
value [`builtins.currentSystem`](../language/builtins.md) for
|
value [`builtins.currentSystem`](@docroot@/language/builtins.md) for
|
||||||
the `system` argument. You can override this using `--arg`, e.g.,
|
the `system` argument. You can override this using `--arg`, e.g.,
|
||||||
`nix-env -iA pkgname --arg system \"i686-freebsd\"`. (Note that
|
`nix-env -iA pkgname --arg system \"i686-freebsd\"`. (Note that
|
||||||
since the argument is a Nix string literal, you have to escape the
|
since the argument is a Nix string literal, you have to escape the
|
||||||
quotes.)
|
quotes.)
|
||||||
|
|
||||||
- [`--argstr`]{#opt-argstr} *name* *value*\
|
- <span id="opt-argstr">[`--argstr`](#opt-argstr)</span> *name* *value*\
|
||||||
This option is like `--arg`, only the value is not a Nix
|
This option is like `--arg`, only the value is not a Nix
|
||||||
expression but a string. So instead of `--arg system
|
expression but a string. So instead of `--arg system
|
||||||
\"i686-linux\"` (the outer quotes are to keep the shell happy) you
|
\"i686-linux\"` (the outer quotes are to keep the shell happy) you
|
||||||
can say `--argstr system i686-linux`.
|
can say `--argstr system i686-linux`.
|
||||||
|
|
||||||
- [`--attr`]{#opt-attr} / `-A` *attrPath*\
|
- <span id="opt-attr">[`--attr`](#opt-attr)</span> / `-A` *attrPath*\
|
||||||
Select an attribute from the top-level Nix expression being
|
Select an attribute from the top-level Nix expression being
|
||||||
evaluated. (`nix-env`, `nix-instantiate`, `nix-build` and
|
evaluated. (`nix-env`, `nix-instantiate`, `nix-build` and
|
||||||
`nix-shell` only.) The *attribute path* *attrPath* is a sequence
|
`nix-shell` only.) The *attribute path* *attrPath* is a sequence
|
||||||
of attribute names separated by dots. For instance, given a
|
of attribute names separated by dots. For instance, given a
|
||||||
top-level Nix expression *e*, the attribute path `xorg.xorgserver`
|
top-level Nix expression *e*, the attribute path `xorg.xorgserver`
|
||||||
would cause the expression `e.xorg.xorgserver` to be used. See
|
would cause the expression `e.xorg.xorgserver` to be used. See
|
||||||
[`nix-env --install`](nix-env.md#operation---install) for some
|
[`nix-env --install`](@docroot@/command-ref/nix-env/install.md) for some
|
||||||
concrete examples.
|
concrete examples.
|
||||||
|
|
||||||
In addition to attribute names, you can also specify array indices.
|
In addition to attribute names, you can also specify array indices.
|
||||||
|
|
@ -191,7 +191,7 @@ Most Nix commands accept the following command-line options:
|
||||||
attribute of the fourth element of the array in the `foo` attribute
|
attribute of the fourth element of the array in the `foo` attribute
|
||||||
of the top-level expression.
|
of the top-level expression.
|
||||||
|
|
||||||
- [`--expr`]{#opt-expr} / `-E`\
|
- <span id="opt-expr">[`--expr`](#opt-expr)</span> / `-E`\
|
||||||
Interpret the command line arguments as a list of Nix expressions to
|
Interpret the command line arguments as a list of Nix expressions to
|
||||||
be parsed and evaluated, rather than as a list of file names of Nix
|
be parsed and evaluated, rather than as a list of file names of Nix
|
||||||
expressions. (`nix-instantiate`, `nix-build` and `nix-shell` only.)
|
expressions. (`nix-instantiate`, `nix-build` and `nix-shell` only.)
|
||||||
|
|
@ -202,17 +202,17 @@ Most Nix commands accept the following command-line options:
|
||||||
use, give your expression to the `nix-shell -p` convenience flag
|
use, give your expression to the `nix-shell -p` convenience flag
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
- [`-I`]{#opt-I} *path*\
|
- <span id="opt-I">[`-I`](#opt-I)</span> *path*\
|
||||||
Add a path to the Nix expression search path. This option may be
|
Add a path to the Nix expression search path. This option may be
|
||||||
given multiple times. See the `NIX_PATH` environment variable for
|
given multiple times. See the `NIX_PATH` environment variable for
|
||||||
information on the semantics of the Nix search path. Paths added
|
information on the semantics of the Nix search path. Paths added
|
||||||
through `-I` take precedence over `NIX_PATH`.
|
through `-I` take precedence over `NIX_PATH`.
|
||||||
|
|
||||||
- [`--option`]{#opt-option} *name* *value*\
|
- <span id="opt-option">[`--option`](#opt-option)</span> *name* *value*\
|
||||||
Set the Nix configuration option *name* to *value*. This overrides
|
Set the Nix configuration option *name* to *value*. This overrides
|
||||||
settings in the Nix configuration file (see nix.conf5).
|
settings in the Nix configuration file (see nix.conf5).
|
||||||
|
|
||||||
- [`--repair`]{#opt-repair}\
|
- <span id="opt-repair">[`--repair`](#opt-repair)</span>\
|
||||||
Fix corrupted or missing store paths by redownloading or rebuilding
|
Fix corrupted or missing store paths by redownloading or rebuilding
|
||||||
them. Note that this is slow because it requires computing a
|
them. Note that this is slow because it requires computing a
|
||||||
cryptographic hash of the contents of every path in the closure of
|
cryptographic hash of the contents of every path in the closure of
|
||||||
|
|
|
||||||
|
|
@ -389,3 +389,35 @@ If a broken link occurs in a snippet that was inserted into multiple generated f
|
||||||
If the `@docroot@` literal appears in an error message from the `mdbook-linkcheck` tool, the `@docroot@` replacement needs to be applied to the generated source file that mentions it.
|
If the `@docroot@` literal appears in an error message from the `mdbook-linkcheck` tool, the `@docroot@` replacement needs to be applied to the generated source file that mentions it.
|
||||||
See existing `@docroot@` logic in the [Makefile].
|
See existing `@docroot@` logic in the [Makefile].
|
||||||
Regular markdown files used for the manual have a base path of their own and they can use relative paths instead of `@docroot@`.
|
Regular markdown files used for the manual have a base path of their own and they can use relative paths instead of `@docroot@`.
|
||||||
|
|
||||||
|
## API documentation
|
||||||
|
|
||||||
|
Doxygen API documentation is [available
|
||||||
|
online](https://hydra.nixos.org/job/nix/master/internal-api-docs/latest/download-by-type/doc/internal-api-docs). You
|
||||||
|
can also build and view it yourself:
|
||||||
|
|
||||||
|
```console
|
||||||
|
# nix build .#hydraJobs.internal-api-docs
|
||||||
|
# xdg-open ./result/share/doc/nix/internal-api/html/index.html
|
||||||
|
```
|
||||||
|
|
||||||
|
or inside a `nix develop` shell by running:
|
||||||
|
|
||||||
|
```
|
||||||
|
# make internal-api-html
|
||||||
|
# xdg-open ./outputs/doc/share/doc/nix/internal-api/html/index.html
|
||||||
|
```
|
||||||
|
|
||||||
|
## Coverage analysis
|
||||||
|
|
||||||
|
A coverage analysis report is [available
|
||||||
|
online](https://hydra.nixos.org/job/nix/master/coverage/latest/download-by-type/report/coverage). You
|
||||||
|
can build it yourself:
|
||||||
|
|
||||||
|
```
|
||||||
|
# nix build .#hydraJobs.coverage
|
||||||
|
# xdg-open ./result/coverage/index.html
|
||||||
|
```
|
||||||
|
|
||||||
|
Metrics about the change in line/function coverage over time are also
|
||||||
|
[available](https://hydra.nixos.org/job/nix/master/coverage#tabs-charts).
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@
|
||||||
|
|
||||||
This means either running the `builder` executable as specified in the corresponding [derivation] or fetching a pre-built [store object] from a [substituter].
|
This means either running the `builder` executable as specified in the corresponding [derivation] or fetching a pre-built [store object] from a [substituter].
|
||||||
|
|
||||||
See [`nix-build`](./command-ref/nix-build.md) and [`nix-store --realise`](./command-ref/nix-store.md#operation---realise).
|
See [`nix-build`](./command-ref/nix-build.md) and [`nix-store --realise`](@docroot@/command-ref/nix-store/realise.md).
|
||||||
|
|
||||||
See [`nix build`](./command-ref/new-cli/nix3-build.md) (experimental).
|
See [`nix build`](./command-ref/new-cli/nix3-build.md) (experimental).
|
||||||
|
|
||||||
|
|
@ -135,14 +135,13 @@
|
||||||
then be built.
|
then be built.
|
||||||
|
|
||||||
- [reference]{#gloss-reference}\
|
- [reference]{#gloss-reference}\
|
||||||
A store path `P` is said to have a reference to a store path `Q` if
|
A [store object] `O` is said to have a *reference* to a store object `P` if a [store path] to `P` appears in the contents of `O`.
|
||||||
the store object at `P` contains the path `Q` somewhere. The
|
|
||||||
*references* of a store path are the set of store paths to which it
|
|
||||||
has a reference.
|
|
||||||
|
|
||||||
A derivation can reference other derivations and sources (but not
|
Store objects can refer to both other store objects and themselves.
|
||||||
output paths), whereas an output path only references other output
|
References from a store object to itself are called *self-references*.
|
||||||
paths.
|
References other than a self-reference must not form a cycle.
|
||||||
|
|
||||||
|
[reference]: #gloss-reference
|
||||||
|
|
||||||
- [reachable]{#gloss-reachable}\
|
- [reachable]{#gloss-reachable}\
|
||||||
A store path `Q` is reachable from another store path `P` if `Q`
|
A store path `Q` is reachable from another store path `P` if `Q`
|
||||||
|
|
@ -159,8 +158,8 @@
|
||||||
files could be missing. The command `nix-store -qR` prints out
|
files could be missing. The command `nix-store -qR` prints out
|
||||||
closures of store paths.
|
closures of store paths.
|
||||||
|
|
||||||
As an example, if the store object at path `P` contains a reference
|
As an example, if the [store object] at path `P` contains a [reference]
|
||||||
to path `Q`, then `Q` is in the closure of `P`. Further, if `Q`
|
to a store object at path `Q`, then `Q` is in the closure of `P`. Further, if `Q`
|
||||||
references `R` then `R` is also in the closure of `P`.
|
references `R` then `R` is also in the closure of `P`.
|
||||||
|
|
||||||
[closure]: #gloss-closure
|
[closure]: #gloss-closure
|
||||||
|
|
@ -193,6 +192,11 @@
|
||||||
A symlink to the current *user environment* of a user, e.g.,
|
A symlink to the current *user environment* of a user, e.g.,
|
||||||
`/nix/var/nix/profiles/default`.
|
`/nix/var/nix/profiles/default`.
|
||||||
|
|
||||||
|
- [installable]{#gloss-installable}\
|
||||||
|
Something that can be realised in the Nix store.
|
||||||
|
|
||||||
|
See [installables](./command-ref/new-cli/nix.md#installables) for [`nix` commands](./command-ref/new-cli/nix.md) (experimental) for details.
|
||||||
|
|
||||||
- [NAR]{#gloss-nar}\
|
- [NAR]{#gloss-nar}\
|
||||||
A *N*ix *AR*chive. This is a serialisation of a path in the Nix
|
A *N*ix *AR*chive. This is a serialisation of a path in the Nix
|
||||||
store. It can contain regular files, directories and symbolic
|
store. It can contain regular files, directories and symbolic
|
||||||
|
|
|
||||||
|
|
@ -42,14 +42,11 @@ export NIX_SSL_CERT_FILE=/etc/ssl/my-certificate-bundle.crt
|
||||||
> You must not add the export and then do the install, as the Nix
|
> You must not add the export and then do the install, as the Nix
|
||||||
> installer will detect the presence of Nix configuration, and abort.
|
> installer will detect the presence of Nix configuration, and abort.
|
||||||
|
|
||||||
## `NIX_SSL_CERT_FILE` with macOS and the Nix daemon
|
If you use the Nix daemon, you should also add the following to
|
||||||
|
`/etc/nix/nix.conf`:
|
||||||
|
|
||||||
On macOS you must specify the environment variable for the Nix daemon
|
```
|
||||||
service, then restart it:
|
ssl-cert-file = /etc/ssl/my-certificate-bundle.crt
|
||||||
|
|
||||||
```console
|
|
||||||
$ sudo launchctl setenv NIX_SSL_CERT_FILE /etc/ssl/my-certificate-bundle.crt
|
|
||||||
$ sudo launchctl kickstart -k system/org.nixos.nix-daemon
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Proxy Environment Variables
|
## Proxy Environment Variables
|
||||||
|
|
|
||||||
|
|
@ -71,3 +71,8 @@
|
||||||
<http://libcpuid.sourceforge.net>.
|
<http://libcpuid.sourceforge.net>.
|
||||||
This is an optional dependency and can be disabled
|
This is an optional dependency and can be disabled
|
||||||
by providing a `--disable-cpuid` to the `configure` script.
|
by providing a `--disable-cpuid` to the `configure` script.
|
||||||
|
|
||||||
|
- Unless `./configure --disable-tests` is specified, GoogleTest (GTest) and
|
||||||
|
RapidCheck are required, which are available at
|
||||||
|
<https://google.github.io/googletest/> and
|
||||||
|
<https://github.com/emil-e/rapidcheck> respectively.
|
||||||
|
|
|
||||||
|
|
@ -198,8 +198,7 @@ Derivations can declare some infrequently used optional attributes.
|
||||||
|
|
||||||
- `"recursive"`\
|
- `"recursive"`\
|
||||||
The hash is computed over the NAR archive dump of the output
|
The hash is computed over the NAR archive dump of the output
|
||||||
(i.e., the result of [`nix-store
|
(i.e., the result of [`nix-store --dump`](@docroot@/command-ref/nix-store/dump.md)). In
|
||||||
--dump`](../command-ref/nix-store.md#operation---dump)). In
|
|
||||||
this case, the output can be anything, including a directory
|
this case, the output can be anything, including a directory
|
||||||
tree.
|
tree.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -43,8 +43,8 @@ If the attribute doesn’t exist, return *value* if provided, otherwise abort ev
|
||||||
An attribute path is a dot-separated list of attribute names.
|
An attribute path is a dot-separated list of attribute names.
|
||||||
An attribute name can be an identifier or a string.
|
An attribute name can be an identifier or a string.
|
||||||
|
|
||||||
> *attrpath* = *name* [ `.` *name* ]...
|
> *attrpath* = *name* [ `.` *name* ]... \
|
||||||
> *name* = *identifier* | *string*
|
> *name* = *identifier* | *string* \
|
||||||
> *identifier* ~ `[a-zA-Z_][a-zA-Z0-9_'-]*`
|
> *identifier* ~ `[a-zA-Z_][a-zA-Z0-9_'-]*`
|
||||||
|
|
||||||
[Attribute selection]: #attribute-selection
|
[Attribute selection]: #attribute-selection
|
||||||
|
|
|
||||||
|
|
@ -205,7 +205,7 @@ You can use arbitrary double-quoted strings as attribute names:
|
||||||
```
|
```
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
let bar = "bar";
|
let bar = "bar"; in
|
||||||
{ "foo ${bar}" = 123; }."foo ${bar}"
|
{ "foo ${bar}" = 123; }."foo ${bar}"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,41 +1,11 @@
|
||||||
# Serving a Nix store via S3
|
# Serving a Nix store via S3
|
||||||
|
|
||||||
Nix has built-in support for storing and fetching store paths from
|
Nix has [built-in support](@docroot@/command-ref/new-cli/nix3-help-stores.md#s3-binary-cache-store)
|
||||||
|
for storing and fetching store paths from
|
||||||
Amazon S3 and S3-compatible services. This uses the same *binary*
|
Amazon S3 and S3-compatible services. This uses the same *binary*
|
||||||
cache mechanism that Nix usually uses to fetch prebuilt binaries from
|
cache mechanism that Nix usually uses to fetch prebuilt binaries from
|
||||||
[cache.nixos.org](https://cache.nixos.org/).
|
[cache.nixos.org](https://cache.nixos.org/).
|
||||||
|
|
||||||
The following options can be specified as URL parameters to the S3 URL:
|
|
||||||
|
|
||||||
- `profile`\
|
|
||||||
The name of the AWS configuration profile to use. By default Nix
|
|
||||||
will use the `default` profile.
|
|
||||||
|
|
||||||
- `region`\
|
|
||||||
The region of the S3 bucket. `us–east-1` by default.
|
|
||||||
|
|
||||||
If your bucket is not in `us–east-1`, you should always explicitly
|
|
||||||
specify the region parameter.
|
|
||||||
|
|
||||||
- `endpoint`\
|
|
||||||
The URL to your S3-compatible service, for when not using Amazon S3.
|
|
||||||
Do not specify this value if you're using Amazon S3.
|
|
||||||
|
|
||||||
> **Note**
|
|
||||||
>
|
|
||||||
> This endpoint must support HTTPS and will use path-based
|
|
||||||
> addressing instead of virtual host based addressing.
|
|
||||||
|
|
||||||
- `scheme`\
|
|
||||||
The scheme used for S3 requests, `https` (default) or `http`. This
|
|
||||||
option allows you to disable HTTPS for binary caches which don't
|
|
||||||
support it.
|
|
||||||
|
|
||||||
> **Note**
|
|
||||||
>
|
|
||||||
> HTTPS should be used if the cache might contain sensitive
|
|
||||||
> information.
|
|
||||||
|
|
||||||
In this example we will use the bucket named `example-nix-cache`.
|
In this example we will use the bucket named `example-nix-cache`.
|
||||||
|
|
||||||
## Anonymous Reads to your S3-compatible binary cache
|
## Anonymous Reads to your S3-compatible binary cache
|
||||||
|
|
|
||||||
|
|
@ -1,2 +1,41 @@
|
||||||
# Release X.Y (202?-??-??)
|
# Release X.Y (202?-??-??)
|
||||||
|
|
||||||
|
* Commands which take installables on the command line can now read them from the standard input if
|
||||||
|
passed the `--stdin` flag. This is primarily useful when you have a large amount of paths which
|
||||||
|
exceed the OS arg limit.
|
||||||
|
|
||||||
|
* The `nix-hash` command now supports Base64 and SRI. Use the flags `--base64`
|
||||||
|
or `--sri` to specify the format of output hash as Base64 or SRI, and `--to-base64`
|
||||||
|
or `--to-sri` to convert a hash to Base64 or SRI format, respectively.
|
||||||
|
|
||||||
|
As the choice of hash formats is no longer binary, the `--base16` flag is also added
|
||||||
|
to explicitly specify the Base16 format, which is still the default.
|
||||||
|
|
||||||
|
* The special handling of an [installable](../command-ref/new-cli/nix.md#installables) with `.drv` suffix being interpreted as all of the given [store derivation](../glossary.md#gloss-store-derivation)'s output paths is removed, and instead taken as the literal store path that it represents.
|
||||||
|
|
||||||
|
The new `^` syntax for store paths introduced in Nix 2.13 allows explicitly referencing output paths of a derivation.
|
||||||
|
Using this is better and more clear than relying on the now-removed `.drv` special handling.
|
||||||
|
|
||||||
|
For example,
|
||||||
|
```shell-session
|
||||||
|
$ nix path-info /nix/store/gzaflydcr6sb3567hap9q6srzx8ggdgg-glibc-2.33-78.drv
|
||||||
|
```
|
||||||
|
|
||||||
|
now gives info about the derivation itself, while
|
||||||
|
|
||||||
|
```shell-session
|
||||||
|
$ nix path-info /nix/store/gzaflydcr6sb3567hap9q6srzx8ggdgg-glibc-2.33-78.drv^*
|
||||||
|
```
|
||||||
|
provides information about each of its outputs.
|
||||||
|
|
||||||
|
* The experimental command `nix describe-stores` has been removed.
|
||||||
|
|
||||||
|
* Nix stores and their settings are now documented in [`nix help-stores`](@docroot@/command-ref/new-cli/nix3-help-stores.md).
|
||||||
|
|
||||||
|
* Documentation for operations of `nix-store` and `nix-env` are now available on separate pages of the manual.
|
||||||
|
They include all common options that can be specified and common environment variables that affect these commands.
|
||||||
|
|
||||||
|
These pages can be viewed offline with `man` using
|
||||||
|
|
||||||
|
* `man nix-store-<operation>` and `man nix-env-<operation>`
|
||||||
|
* `nix-store --help --<operation>` and `nix-env --help --<operation>`.
|
||||||
|
|
|
||||||
|
|
@ -38,4 +38,46 @@ rec {
|
||||||
|
|
||||||
filterAttrs = pred: set:
|
filterAttrs = pred: set:
|
||||||
listToAttrs (concatMap (name: let v = set.${name}; in if pred name v then [(nameValuePair name v)] else []) (attrNames set));
|
listToAttrs (concatMap (name: let v = set.${name}; in if pred name v then [(nameValuePair name v)] else []) (attrNames set));
|
||||||
|
|
||||||
|
showSetting = { useAnchors }: name: { description, documentDefault, defaultValue, aliases, value }:
|
||||||
|
let
|
||||||
|
result = squash ''
|
||||||
|
- ${if useAnchors
|
||||||
|
then ''<span id="conf-${name}">[`${name}`](#conf-${name})</span>''
|
||||||
|
else ''`${name}`''}
|
||||||
|
|
||||||
|
${indent " " body}
|
||||||
|
'';
|
||||||
|
|
||||||
|
# separate body to cleanly handle indentation
|
||||||
|
body = ''
|
||||||
|
${description}
|
||||||
|
|
||||||
|
**Default:** ${showDefault documentDefault defaultValue}
|
||||||
|
|
||||||
|
${showAliases aliases}
|
||||||
|
'';
|
||||||
|
|
||||||
|
showDefault = documentDefault: defaultValue:
|
||||||
|
if documentDefault then
|
||||||
|
# a StringMap value type is specified as a string, but
|
||||||
|
# this shows the value type. The empty stringmap is `null` in
|
||||||
|
# JSON, but that converts to `{ }` here.
|
||||||
|
if defaultValue == "" || defaultValue == [] || isAttrs defaultValue
|
||||||
|
then "*empty*"
|
||||||
|
else if isBool defaultValue then
|
||||||
|
if defaultValue then "`true`" else "`false`"
|
||||||
|
else "`${toString defaultValue}`"
|
||||||
|
else "*machine-specific*";
|
||||||
|
|
||||||
|
showAliases = aliases:
|
||||||
|
if aliases == [] then "" else
|
||||||
|
"**Deprecated alias:** ${(concatStringsSep ", " (map (s: "`${s}`") aliases))}";
|
||||||
|
|
||||||
|
indent = prefix: s:
|
||||||
|
concatStringsSep "\n" (map (x: if x == "" then x else "${prefix}${x}") (splitLines s));
|
||||||
|
|
||||||
|
in result;
|
||||||
|
|
||||||
|
showSettings = args: settingsInfo: concatStrings (attrValues (mapAttrs (showSetting args) settingsInfo));
|
||||||
}
|
}
|
||||||
|
|
|
||||||
12
docker.nix
12
docker.nix
|
|
@ -8,6 +8,7 @@
|
||||||
, extraPkgs ? []
|
, extraPkgs ? []
|
||||||
, maxLayers ? 100
|
, maxLayers ? 100
|
||||||
, nixConf ? {}
|
, nixConf ? {}
|
||||||
|
, flake-registry ? null
|
||||||
}:
|
}:
|
||||||
let
|
let
|
||||||
defaultPkgs = with pkgs; [
|
defaultPkgs = with pkgs; [
|
||||||
|
|
@ -247,7 +248,16 @@ let
|
||||||
mkdir -p $out/bin $out/usr/bin
|
mkdir -p $out/bin $out/usr/bin
|
||||||
ln -s ${pkgs.coreutils}/bin/env $out/usr/bin/env
|
ln -s ${pkgs.coreutils}/bin/env $out/usr/bin/env
|
||||||
ln -s ${pkgs.bashInteractive}/bin/bash $out/bin/sh
|
ln -s ${pkgs.bashInteractive}/bin/bash $out/bin/sh
|
||||||
'';
|
|
||||||
|
'' + (lib.optionalString (flake-registry != null) ''
|
||||||
|
nixCacheDir="/root/.cache/nix"
|
||||||
|
mkdir -p $out$nixCacheDir
|
||||||
|
globalFlakeRegistryPath="$nixCacheDir/flake-registry.json"
|
||||||
|
ln -s ${flake-registry}/flake-registry.json $out$globalFlakeRegistryPath
|
||||||
|
mkdir -p $out/nix/var/nix/gcroots/auto
|
||||||
|
rootName=$(${pkgs.nix}/bin/nix --extra-experimental-features nix-command hash file --type sha1 --base32 <(echo -n $globalFlakeRegistryPath))
|
||||||
|
ln -s $globalFlakeRegistryPath $out/nix/var/nix/gcroots/auto/$rootName
|
||||||
|
'');
|
||||||
|
|
||||||
in
|
in
|
||||||
pkgs.dockerTools.buildLayeredImageWithNixDb {
|
pkgs.dockerTools.buildLayeredImageWithNixDb {
|
||||||
|
|
|
||||||
17
flake.lock
17
flake.lock
|
|
@ -1,5 +1,21 @@
|
||||||
{
|
{
|
||||||
"nodes": {
|
"nodes": {
|
||||||
|
"flake-compat": {
|
||||||
|
"flake": false,
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1673956053,
|
||||||
|
"narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
|
||||||
|
"owner": "edolstra",
|
||||||
|
"repo": "flake-compat",
|
||||||
|
"rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "edolstra",
|
||||||
|
"repo": "flake-compat",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
"lowdown-src": {
|
"lowdown-src": {
|
||||||
"flake": false,
|
"flake": false,
|
||||||
"locked": {
|
"locked": {
|
||||||
|
|
@ -50,6 +66,7 @@
|
||||||
},
|
},
|
||||||
"root": {
|
"root": {
|
||||||
"inputs": {
|
"inputs": {
|
||||||
|
"flake-compat": "flake-compat",
|
||||||
"lowdown-src": "lowdown-src",
|
"lowdown-src": "lowdown-src",
|
||||||
"nixpkgs": "nixpkgs",
|
"nixpkgs": "nixpkgs",
|
||||||
"nixpkgs-regression": "nixpkgs-regression"
|
"nixpkgs-regression": "nixpkgs-regression"
|
||||||
|
|
|
||||||
107
flake.nix
107
flake.nix
|
|
@ -4,8 +4,9 @@
|
||||||
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-22.11-small";
|
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-22.11-small";
|
||||||
inputs.nixpkgs-regression.url = "github:NixOS/nixpkgs/215d4d0fd80ca5163643b03a33fde804a29cc1e2";
|
inputs.nixpkgs-regression.url = "github:NixOS/nixpkgs/215d4d0fd80ca5163643b03a33fde804a29cc1e2";
|
||||||
inputs.lowdown-src = { url = "github:kristapsdz/lowdown"; flake = false; };
|
inputs.lowdown-src = { url = "github:kristapsdz/lowdown"; flake = false; };
|
||||||
|
inputs.flake-compat = { url = "github:edolstra/flake-compat"; flake = false; };
|
||||||
|
|
||||||
outputs = { self, nixpkgs, nixpkgs-regression, lowdown-src }:
|
outputs = { self, nixpkgs, nixpkgs-regression, lowdown-src, flake-compat }:
|
||||||
|
|
||||||
let
|
let
|
||||||
inherit (nixpkgs) lib;
|
inherit (nixpkgs) lib;
|
||||||
|
|
@ -89,9 +90,7 @@
|
||||||
});
|
});
|
||||||
|
|
||||||
configureFlags =
|
configureFlags =
|
||||||
[
|
lib.optionals stdenv.isLinux [
|
||||||
"CXXFLAGS=-I${lib.getDev rapidcheck}/extras/gtest/include"
|
|
||||||
] ++ lib.optionals stdenv.isLinux [
|
|
||||||
"--with-boost=${boost}/lib"
|
"--with-boost=${boost}/lib"
|
||||||
"--with-sandbox-shell=${sh}/bin/busybox"
|
"--with-sandbox-shell=${sh}/bin/busybox"
|
||||||
]
|
]
|
||||||
|
|
@ -99,6 +98,14 @@
|
||||||
"LDFLAGS=-fuse-ld=gold"
|
"LDFLAGS=-fuse-ld=gold"
|
||||||
];
|
];
|
||||||
|
|
||||||
|
testConfigureFlags = [
|
||||||
|
"RAPIDCHECK_HEADERS=${lib.getDev rapidcheck}/extras/gtest/include"
|
||||||
|
];
|
||||||
|
|
||||||
|
internalApiDocsConfigureFlags = [
|
||||||
|
"--enable-internal-api-docs"
|
||||||
|
];
|
||||||
|
|
||||||
nativeBuildDeps =
|
nativeBuildDeps =
|
||||||
[
|
[
|
||||||
buildPackages.bison
|
buildPackages.bison
|
||||||
|
|
@ -124,13 +131,20 @@
|
||||||
libarchive
|
libarchive
|
||||||
boost
|
boost
|
||||||
lowdown-nix
|
lowdown-nix
|
||||||
gtest
|
|
||||||
rapidcheck
|
|
||||||
]
|
]
|
||||||
++ lib.optionals stdenv.isLinux [libseccomp]
|
++ lib.optionals stdenv.isLinux [libseccomp]
|
||||||
++ lib.optional (stdenv.isLinux || stdenv.isDarwin) libsodium
|
++ lib.optional (stdenv.isLinux || stdenv.isDarwin) libsodium
|
||||||
++ lib.optional stdenv.hostPlatform.isx86_64 libcpuid;
|
++ lib.optional stdenv.hostPlatform.isx86_64 libcpuid;
|
||||||
|
|
||||||
|
checkDeps = [
|
||||||
|
gtest
|
||||||
|
rapidcheck
|
||||||
|
];
|
||||||
|
|
||||||
|
internalApiDocsDeps = [
|
||||||
|
buildPackages.doxygen
|
||||||
|
];
|
||||||
|
|
||||||
awsDeps = lib.optional (stdenv.isLinux || stdenv.isDarwin)
|
awsDeps = lib.optional (stdenv.isLinux || stdenv.isDarwin)
|
||||||
(aws-sdk-cpp.override {
|
(aws-sdk-cpp.override {
|
||||||
apis = ["s3" "transfer"];
|
apis = ["s3" "transfer"];
|
||||||
|
|
@ -200,7 +214,7 @@
|
||||||
VERSION_SUFFIX = versionSuffix;
|
VERSION_SUFFIX = versionSuffix;
|
||||||
|
|
||||||
nativeBuildInputs = nativeBuildDeps;
|
nativeBuildInputs = nativeBuildDeps;
|
||||||
buildInputs = buildDeps ++ awsDeps;
|
buildInputs = buildDeps ++ awsDeps ++ checkDeps;
|
||||||
propagatedBuildInputs = propagatedDeps;
|
propagatedBuildInputs = propagatedDeps;
|
||||||
|
|
||||||
enableParallelBuilding = true;
|
enableParallelBuilding = true;
|
||||||
|
|
@ -305,12 +319,18 @@
|
||||||
};
|
};
|
||||||
let
|
let
|
||||||
canRunInstalled = currentStdenv.buildPlatform.canExecute currentStdenv.hostPlatform;
|
canRunInstalled = currentStdenv.buildPlatform.canExecute currentStdenv.hostPlatform;
|
||||||
in currentStdenv.mkDerivation {
|
|
||||||
|
sourceByRegexInverted = rxs: origSrc: final.lib.cleanSourceWith {
|
||||||
|
filter = (path: type:
|
||||||
|
let relPath = final.lib.removePrefix (toString origSrc + "/") (toString path);
|
||||||
|
in ! lib.any (re: builtins.match re relPath != null) rxs);
|
||||||
|
src = origSrc;
|
||||||
|
};
|
||||||
|
in currentStdenv.mkDerivation (finalAttrs: {
|
||||||
name = "nix-${version}";
|
name = "nix-${version}";
|
||||||
inherit version;
|
inherit version;
|
||||||
|
|
||||||
src = self;
|
src = sourceByRegexInverted [ "tests/nixos/.*" "tests/installer/.*" ] self;
|
||||||
|
|
||||||
VERSION_SUFFIX = versionSuffix;
|
VERSION_SUFFIX = versionSuffix;
|
||||||
|
|
||||||
outputs = [ "out" "dev" "doc" ];
|
outputs = [ "out" "dev" "doc" ];
|
||||||
|
|
@ -318,7 +338,8 @@
|
||||||
nativeBuildInputs = nativeBuildDeps;
|
nativeBuildInputs = nativeBuildDeps;
|
||||||
buildInputs = buildDeps
|
buildInputs = buildDeps
|
||||||
# There have been issues building these dependencies
|
# There have been issues building these dependencies
|
||||||
++ lib.optionals (currentStdenv.hostPlatform == currentStdenv.buildPlatform) awsDeps;
|
++ lib.optionals (currentStdenv.hostPlatform == currentStdenv.buildPlatform) awsDeps
|
||||||
|
++ lib.optionals finalAttrs.doCheck checkDeps;
|
||||||
|
|
||||||
propagatedBuildInputs = propagatedDeps;
|
propagatedBuildInputs = propagatedDeps;
|
||||||
|
|
||||||
|
|
@ -348,6 +369,8 @@
|
||||||
configureFlags = configureFlags ++
|
configureFlags = configureFlags ++
|
||||||
[ "--sysconfdir=/etc" ] ++
|
[ "--sysconfdir=/etc" ] ++
|
||||||
lib.optional stdenv.hostPlatform.isStatic "--enable-embedded-sandbox-shell" ++
|
lib.optional stdenv.hostPlatform.isStatic "--enable-embedded-sandbox-shell" ++
|
||||||
|
[ (lib.enableFeature finalAttrs.doCheck "tests") ] ++
|
||||||
|
lib.optionals finalAttrs.doCheck testConfigureFlags ++
|
||||||
lib.optional (!canRunInstalled) "--disable-doc-gen";
|
lib.optional (!canRunInstalled) "--disable-doc-gen";
|
||||||
|
|
||||||
enableParallelBuilding = true;
|
enableParallelBuilding = true;
|
||||||
|
|
@ -361,6 +384,10 @@
|
||||||
postInstall = ''
|
postInstall = ''
|
||||||
mkdir -p $doc/nix-support
|
mkdir -p $doc/nix-support
|
||||||
echo "doc manual $doc/share/doc/nix/manual" >> $doc/nix-support/hydra-build-products
|
echo "doc manual $doc/share/doc/nix/manual" >> $doc/nix-support/hydra-build-products
|
||||||
|
${lib.optionalString currentStdenv.hostPlatform.isStatic ''
|
||||||
|
mkdir -p $out/nix-support
|
||||||
|
echo "file binary-dist $out/bin/nix" >> $out/nix-support/hydra-build-products
|
||||||
|
''}
|
||||||
${lib.optionalString currentStdenv.isDarwin ''
|
${lib.optionalString currentStdenv.isDarwin ''
|
||||||
install_name_tool \
|
install_name_tool \
|
||||||
-change ${boost}/lib/libboost_context.dylib \
|
-change ${boost}/lib/libboost_context.dylib \
|
||||||
|
|
@ -369,8 +396,9 @@
|
||||||
''}
|
''}
|
||||||
'';
|
'';
|
||||||
|
|
||||||
doInstallCheck = true;
|
doInstallCheck = finalAttrs.doCheck;
|
||||||
installCheckFlags = "sysconfdir=$(out)/etc";
|
installCheckFlags = "sysconfdir=$(out)/etc";
|
||||||
|
installCheckTarget = "installcheck"; # work around buggy detection in stdenv
|
||||||
|
|
||||||
separateDebugInfo = !currentStdenv.hostPlatform.isStatic;
|
separateDebugInfo = !currentStdenv.hostPlatform.isStatic;
|
||||||
|
|
||||||
|
|
@ -411,7 +439,7 @@
|
||||||
});
|
});
|
||||||
|
|
||||||
meta.platforms = lib.platforms.unix;
|
meta.platforms = lib.platforms.unix;
|
||||||
};
|
});
|
||||||
|
|
||||||
lowdown-nix = with final; currentStdenv.mkDerivation rec {
|
lowdown-nix = with final; currentStdenv.mkDerivation rec {
|
||||||
name = "lowdown-0.9.0";
|
name = "lowdown-0.9.0";
|
||||||
|
|
@ -462,6 +490,14 @@
|
||||||
|
|
||||||
buildNoGc = forAllSystems (system: self.packages.${system}.nix.overrideAttrs (a: { configureFlags = (a.configureFlags or []) ++ ["--enable-gc=no"];}));
|
buildNoGc = forAllSystems (system: self.packages.${system}.nix.overrideAttrs (a: { configureFlags = (a.configureFlags or []) ++ ["--enable-gc=no"];}));
|
||||||
|
|
||||||
|
buildNoTests = forAllSystems (system:
|
||||||
|
self.packages.${system}.nix.overrideAttrs (a: {
|
||||||
|
doCheck =
|
||||||
|
assert ! a?dontCheck;
|
||||||
|
false;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
# Perl bindings for various platforms.
|
# Perl bindings for various platforms.
|
||||||
perlBindings = forAllSystems (system: nixpkgsFor.${system}.native.nix.perl-bindings);
|
perlBindings = forAllSystems (system: nixpkgsFor.${system}.native.nix.perl-bindings);
|
||||||
|
|
||||||
|
|
@ -496,25 +532,48 @@
|
||||||
|
|
||||||
src = self;
|
src = self;
|
||||||
|
|
||||||
configureFlags = [
|
configureFlags = testConfigureFlags;
|
||||||
"CXXFLAGS=-I${lib.getDev pkgs.rapidcheck}/extras/gtest/include"
|
|
||||||
];
|
|
||||||
|
|
||||||
enableParallelBuilding = true;
|
enableParallelBuilding = true;
|
||||||
|
|
||||||
nativeBuildInputs = nativeBuildDeps;
|
nativeBuildInputs = nativeBuildDeps;
|
||||||
buildInputs = buildDeps ++ propagatedDeps ++ awsDeps;
|
buildInputs = buildDeps ++ propagatedDeps ++ awsDeps ++ checkDeps;
|
||||||
|
|
||||||
dontInstall = false;
|
dontInstall = false;
|
||||||
|
|
||||||
doInstallCheck = true;
|
doInstallCheck = true;
|
||||||
|
installCheckTarget = "installcheck"; # work around buggy detection in stdenv
|
||||||
|
|
||||||
lcovFilter = [ "*/boost/*" "*-tab.*" ];
|
lcovFilter = [ "*/boost/*" "*-tab.*" ];
|
||||||
|
|
||||||
# We call `dot', and even though we just use it to
|
hardeningDisable = ["fortify"];
|
||||||
# syntax-check generated dot files, it still requires some
|
};
|
||||||
# fonts. So provide those.
|
|
||||||
FONTCONFIG_FILE = texFunctions.fontsConf;
|
# API docs for Nix's unstable internal C++ interfaces.
|
||||||
|
internal-api-docs =
|
||||||
|
with nixpkgsFor.x86_64-linux.native;
|
||||||
|
with commonDeps { inherit pkgs; };
|
||||||
|
|
||||||
|
stdenv.mkDerivation {
|
||||||
|
pname = "nix-internal-api-docs";
|
||||||
|
inherit version;
|
||||||
|
|
||||||
|
src = self;
|
||||||
|
|
||||||
|
configureFlags = testConfigureFlags ++ internalApiDocsConfigureFlags;
|
||||||
|
|
||||||
|
nativeBuildInputs = nativeBuildDeps;
|
||||||
|
buildInputs = buildDeps ++ propagatedDeps
|
||||||
|
++ awsDeps ++ checkDeps ++ internalApiDocsDeps;
|
||||||
|
|
||||||
|
dontBuild = true;
|
||||||
|
|
||||||
|
installTargets = [ "internal-api-html" ];
|
||||||
|
|
||||||
|
postInstall = ''
|
||||||
|
mkdir -p $out/nix-support
|
||||||
|
echo "doc internal-api-docs $out/share/doc/nix/internal-api/html" >> $out/nix-support/hydra-build-products
|
||||||
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
# System tests.
|
# System tests.
|
||||||
|
|
@ -634,9 +693,11 @@
|
||||||
nativeBuildInputs = nativeBuildDeps
|
nativeBuildInputs = nativeBuildDeps
|
||||||
++ (lib.optionals stdenv.cc.isClang [ pkgs.bear pkgs.clang-tools ]);
|
++ (lib.optionals stdenv.cc.isClang [ pkgs.bear pkgs.clang-tools ]);
|
||||||
|
|
||||||
buildInputs = buildDeps ++ propagatedDeps ++ awsDeps;
|
buildInputs = buildDeps ++ propagatedDeps
|
||||||
|
++ awsDeps ++ checkDeps ++ internalApiDocsDeps;
|
||||||
|
|
||||||
inherit configureFlags;
|
configureFlags = configureFlags
|
||||||
|
++ testConfigureFlags ++ internalApiDocsConfigureFlags;
|
||||||
|
|
||||||
enableParallelBuilding = true;
|
enableParallelBuilding = true;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,30 @@
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
The goal of the team is to help other people to contribute to Nix.
|
The team's main responsibility is to set a direction for the development of Nix and ensure that the code is in good shape.
|
||||||
|
|
||||||
|
We aim to achieve this by improving the contributor experience and attracting more maintainers – that is, by helping other people contributing to Nix and eventually taking responsibility – in order to scale the development process to match users' needs.
|
||||||
|
|
||||||
|
### Objectives
|
||||||
|
|
||||||
|
- It is obvious what is worthwhile to work on.
|
||||||
|
- It is easy to find the right place in the code to make a change.
|
||||||
|
- It is clear what is expected of a pull request.
|
||||||
|
- It is predictable how to get a change merged and released.
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
- Establish, communicate, and maintain a technical roadmap
|
||||||
|
- Improve documentation targeted at contributors
|
||||||
|
- Record architecture and design decisions
|
||||||
|
- Elaborate contribution guides and abide to them
|
||||||
|
- Define and assert quality criteria for contributions
|
||||||
|
- Maintain the issue tracker and triage pull requests
|
||||||
|
- Help contributors succeed with pull requests that address roadmap milestones
|
||||||
|
- Manage the release lifecycle
|
||||||
|
- Regularly publish reports on work done
|
||||||
|
- Engage with third parties in the interest of the project
|
||||||
|
- Ensure the required maintainer capacity for all of the above
|
||||||
|
|
||||||
## Members
|
## Members
|
||||||
|
|
||||||
|
|
@ -11,6 +34,7 @@ The goal of the team is to help other people to contribute to Nix.
|
||||||
- Valentin Gagarin (@fricklerhandwerk)
|
- Valentin Gagarin (@fricklerhandwerk)
|
||||||
- Thomas Bereknyei (@tomberek)
|
- Thomas Bereknyei (@tomberek)
|
||||||
- Robert Hensing (@roberth)
|
- Robert Hensing (@roberth)
|
||||||
|
- John Ericson (@Ericson2314)
|
||||||
|
|
||||||
## Meeting protocol
|
## Meeting protocol
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -123,6 +123,7 @@ release:
|
||||||
`/home/eelco/Dev/nixpkgs-pristine`.
|
`/home/eelco/Dev/nixpkgs-pristine`.
|
||||||
|
|
||||||
TODO: trigger nixos.org netlify: https://docs.netlify.com/configure-builds/build-hooks/
|
TODO: trigger nixos.org netlify: https://docs.netlify.com/configure-builds/build-hooks/
|
||||||
|
|
||||||
* Prepare for the next point release by editing `.version` to
|
* Prepare for the next point release by editing `.version` to
|
||||||
e.g.
|
e.g.
|
||||||
|
|
||||||
|
|
@ -152,7 +153,7 @@ release:
|
||||||
from the previous milestone, and close the previous milestone. Set
|
from the previous milestone, and close the previous milestone. Set
|
||||||
the date for the next milestone 6 weeks from now.
|
the date for the next milestone 6 weeks from now.
|
||||||
|
|
||||||
* Create a backport label
|
* Create a backport label.
|
||||||
|
|
||||||
* Post an [announcement on Discourse](https://discourse.nixos.org/c/announcements/8), including the contents of
|
* Post an [announcement on Discourse](https://discourse.nixos.org/c/announcements/8), including the contents of
|
||||||
`rl-$VERSION.md`.
|
`rl-$VERSION.md`.
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,6 @@
|
||||||
<dict>
|
<dict>
|
||||||
<key>EnvironmentVariables</key>
|
<key>EnvironmentVariables</key>
|
||||||
<dict>
|
<dict>
|
||||||
<key>NIX_SSL_CERT_FILE</key>
|
|
||||||
<string>/nix/var/nix/profiles/default/etc/ssl/certs/ca-bundle.crt</string>
|
|
||||||
<key>OBJC_DISABLE_INITIALIZE_FORK_SAFETY</key>
|
<key>OBJC_DISABLE_INITIALIZE_FORK_SAFETY</key>
|
||||||
<string>YES</string>
|
<string>YES</string>
|
||||||
</dict>
|
</dict>
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
set -eu
|
set -eu -o pipefail
|
||||||
|
|
||||||
test=$1
|
test=$1
|
||||||
|
|
||||||
|
|
|
||||||
12
mk/disable-tests.mk
Normal file
12
mk/disable-tests.mk
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
# This file is only active for `./configure --disable-tests`.
|
||||||
|
# Running `make check` or `make installcheck` would indicate a mistake in the
|
||||||
|
# caller.
|
||||||
|
|
||||||
|
installcheck:
|
||||||
|
@echo "Tests are disabled. Configure without '--disable-tests', or avoid calling 'make installcheck'."
|
||||||
|
@exit 1
|
||||||
|
|
||||||
|
# This currently has little effect.
|
||||||
|
check:
|
||||||
|
@echo "Tests are disabled. Configure without '--disable-tests', or avoid calling 'make check'."
|
||||||
|
@exit 1
|
||||||
|
|
@ -126,7 +126,7 @@ define build-library
|
||||||
$(1)_PATH := $$(_d)/$$($(1)_NAME).a
|
$(1)_PATH := $$(_d)/$$($(1)_NAME).a
|
||||||
|
|
||||||
$$($(1)_PATH): $$($(1)_OBJS) | $$(_d)/
|
$$($(1)_PATH): $$($(1)_OBJS) | $$(_d)/
|
||||||
+$$(trace-ld) $(LD) -Ur -o $$(_d)/$$($(1)_NAME).o $$^
|
$$(trace-ld) $(LD) $$(ifndef $(HOST_DARWIN),-U) -r -o $$(_d)/$$($(1)_NAME).o $$^
|
||||||
$$(trace-ar) $(AR) crs $$@ $$(_d)/$$($(1)_NAME).o
|
$$(trace-ar) $(AR) crs $$@ $$(_d)/$$($(1)_NAME).o
|
||||||
|
|
||||||
$(1)_LDFLAGS_USE += $$($(1)_PATH) $$($(1)_LDFLAGS) $$(foreach lib, $$($(1)_LIBS), $$($$(lib)_LDFLAGS_USE))
|
$(1)_LDFLAGS_USE += $$($(1)_PATH) $$($(1)_LDFLAGS) $$(foreach lib, $$($(1)_LIBS), $$($$(lib)_LDFLAGS_USE))
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
set -u
|
set -eu -o pipefail
|
||||||
|
|
||||||
red=""
|
red=""
|
||||||
green=""
|
green=""
|
||||||
|
|
@ -22,24 +22,11 @@ fi
|
||||||
|
|
||||||
run_test () {
|
run_test () {
|
||||||
(init_test 2>/dev/null > /dev/null)
|
(init_test 2>/dev/null > /dev/null)
|
||||||
log="$(run_test_proper 2>&1)"
|
log="$(run_test_proper 2>&1)" && status=0 || status=$?
|
||||||
status=$?
|
|
||||||
}
|
}
|
||||||
|
|
||||||
run_test
|
run_test
|
||||||
|
|
||||||
# Hack: Retry the test if it fails with “unexpected EOF reading a line” as these
|
|
||||||
# appear randomly without anyone knowing why.
|
|
||||||
# See https://github.com/NixOS/nix/issues/3605 for more info
|
|
||||||
if [[ $status -ne 0 && $status -ne 99 && \
|
|
||||||
"$(uname)" == "Darwin" && \
|
|
||||||
"$log" =~ "unexpected EOF reading a line" \
|
|
||||||
]]; then
|
|
||||||
echo "$post_run_msg [${yellow}FAIL$normal] (possibly flaky, so will be retried)"
|
|
||||||
echo "$log" | sed 's/^/ /'
|
|
||||||
run_test
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ $status -eq 0 ]; then
|
if [ $status -eq 0 ]; then
|
||||||
echo "$post_run_msg [${green}PASS$normal]"
|
echo "$post_run_msg [${green}PASS$normal]"
|
||||||
elif [ $status -eq 99 ]; then
|
elif [ $status -eq 99 ]; then
|
||||||
|
|
|
||||||
|
|
@ -3,12 +3,12 @@ if [ -n "${__ETC_PROFILE_NIX_SOURCED:-}" ]; then return; fi
|
||||||
__ETC_PROFILE_NIX_SOURCED=1
|
__ETC_PROFILE_NIX_SOURCED=1
|
||||||
|
|
||||||
NIX_LINK=$HOME/.nix-profile
|
NIX_LINK=$HOME/.nix-profile
|
||||||
if [ -n "$XDG_STATE_HOME" ]; then
|
if [ -n "${XDG_STATE_HOME-}" ]; then
|
||||||
NIX_LINK_NEW="$XDG_STATE_HOME/nix/profile"
|
NIX_LINK_NEW="$XDG_STATE_HOME/nix/profile"
|
||||||
else
|
else
|
||||||
NIX_LINK_NEW=$HOME/.local/state/nix/profile
|
NIX_LINK_NEW=$HOME/.local/state/nix/profile
|
||||||
fi
|
fi
|
||||||
if ! [ -e "$NIX_LINK" ]; then
|
if [ -e "$NIX_LINK_NEW" ]; then
|
||||||
NIX_LINK="$NIX_LINK_NEW"
|
NIX_LINK="$NIX_LINK_NEW"
|
||||||
else
|
else
|
||||||
if [ -t 2 ] && [ -e "$NIX_LINK_NEW" ]; then
|
if [ -t 2 ] && [ -e "$NIX_LINK_NEW" ]; then
|
||||||
|
|
|
||||||
|
|
@ -3,12 +3,12 @@ if [ -n "$HOME" ] && [ -n "$USER" ]; then
|
||||||
# Set up the per-user profile.
|
# Set up the per-user profile.
|
||||||
|
|
||||||
NIX_LINK="$HOME/.nix-profile"
|
NIX_LINK="$HOME/.nix-profile"
|
||||||
if [ -n "$XDG_STATE_HOME" ]; then
|
if [ -n "${XDG_STATE_HOME-}" ]; then
|
||||||
NIX_LINK_NEW="$XDG_STATE_HOME/nix/profile"
|
NIX_LINK_NEW="$XDG_STATE_HOME/nix/profile"
|
||||||
else
|
else
|
||||||
NIX_LINK_NEW="$HOME/.local/state/nix/profile"
|
NIX_LINK_NEW="$HOME/.local/state/nix/profile"
|
||||||
fi
|
fi
|
||||||
if ! [ -e "$NIX_LINK" ]; then
|
if [ -e "$NIX_LINK_NEW" ]; then
|
||||||
NIX_LINK="$NIX_LINK_NEW"
|
NIX_LINK="$NIX_LINK_NEW"
|
||||||
else
|
else
|
||||||
if [ -t 2 ] && [ -e "$NIX_LINK_NEW" ]; then
|
if [ -t 2 ] && [ -e "$NIX_LINK_NEW" ]; then
|
||||||
|
|
|
||||||
|
|
@ -219,7 +219,7 @@ static int main_build_remote(int argc, char * * argv)
|
||||||
% concatStringsSep<StringSet>(", ", m.supportedFeatures)
|
% concatStringsSep<StringSet>(", ", m.supportedFeatures)
|
||||||
% concatStringsSep<StringSet>(", ", m.mandatoryFeatures);
|
% concatStringsSep<StringSet>(", ", m.mandatoryFeatures);
|
||||||
|
|
||||||
printMsg(couldBuildLocally ? lvlChatty : lvlWarn, error);
|
printMsg(couldBuildLocally ? lvlChatty : lvlWarn, error.str());
|
||||||
|
|
||||||
std::cerr << "# decline\n";
|
std::cerr << "# decline\n";
|
||||||
}
|
}
|
||||||
|
|
@ -305,7 +305,7 @@ connected:
|
||||||
|
|
||||||
std::set<Realisation> missingRealisations;
|
std::set<Realisation> missingRealisations;
|
||||||
StorePathSet missingPaths;
|
StorePathSet missingPaths;
|
||||||
if (settings.isExperimentalFeatureEnabled(Xp::CaDerivations) && !drv.type().hasKnownOutputPaths()) {
|
if (experimentalFeatureSettings.isEnabled(Xp::CaDerivations) && !drv.type().hasKnownOutputPaths()) {
|
||||||
for (auto & outputName : wantedOutputs) {
|
for (auto & outputName : wantedOutputs) {
|
||||||
auto thisOutputHash = outputHashes.at(outputName);
|
auto thisOutputHash = outputHashes.at(outputName);
|
||||||
auto thisOutputId = DrvOutput{ thisOutputHash, outputName };
|
auto thisOutputId = DrvOutput{ thisOutputHash, outputName };
|
||||||
|
|
@ -337,7 +337,7 @@ connected:
|
||||||
for (auto & realisation : missingRealisations) {
|
for (auto & realisation : missingRealisations) {
|
||||||
// Should hold, because if the feature isn't enabled the set
|
// Should hold, because if the feature isn't enabled the set
|
||||||
// of missing realisations should be empty
|
// of missing realisations should be empty
|
||||||
settings.requireExperimentalFeature(Xp::CaDerivations);
|
experimentalFeatureSettings.require(Xp::CaDerivations);
|
||||||
store->registerDrvOutput(realisation);
|
store->registerDrvOutput(realisation);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
11
src/libcmd/command-installable-value.cc
Normal file
11
src/libcmd/command-installable-value.cc
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
#include "command-installable-value.hh"
|
||||||
|
|
||||||
|
namespace nix {
|
||||||
|
|
||||||
|
void InstallableValueCommand::run(ref<Store> store, ref<Installable> installable)
|
||||||
|
{
|
||||||
|
auto installableValue = InstallableValue::require(installable);
|
||||||
|
run(store, installableValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
13
src/libcmd/command-installable-value.hh
Normal file
13
src/libcmd/command-installable-value.hh
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#include "installable-value.hh"
|
||||||
|
#include "command.hh"
|
||||||
|
|
||||||
|
namespace nix {
|
||||||
|
|
||||||
|
struct InstallableValueCommand : InstallableCommand
|
||||||
|
{
|
||||||
|
virtual void run(ref<Store> store, ref<InstallableValue> installable) = 0;
|
||||||
|
|
||||||
|
void run(ref<Store> store, ref<Installable> installable) override;
|
||||||
|
};
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -165,7 +165,7 @@ BuiltPathsCommand::BuiltPathsCommand(bool recursive)
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
void BuiltPathsCommand::run(ref<Store> store)
|
void BuiltPathsCommand::run(ref<Store> store, Installables && installables)
|
||||||
{
|
{
|
||||||
BuiltPaths paths;
|
BuiltPaths paths;
|
||||||
if (all) {
|
if (all) {
|
||||||
|
|
@ -211,7 +211,7 @@ void StorePathsCommand::run(ref<Store> store, BuiltPaths && paths)
|
||||||
run(store, std::move(sorted));
|
run(store, std::move(sorted));
|
||||||
}
|
}
|
||||||
|
|
||||||
void StorePathCommand::run(ref<Store> store, std::vector<StorePath> && storePaths)
|
void StorePathCommand::run(ref<Store> store, StorePaths && storePaths)
|
||||||
{
|
{
|
||||||
if (storePaths.size() != 1)
|
if (storePaths.size() != 1)
|
||||||
throw UsageError("this command requires exactly one store path");
|
throw UsageError("this command requires exactly one store path");
|
||||||
|
|
@ -246,7 +246,7 @@ void MixProfile::updateProfile(const BuiltPaths & buildables)
|
||||||
{
|
{
|
||||||
if (!profile) return;
|
if (!profile) return;
|
||||||
|
|
||||||
std::vector<StorePath> result;
|
StorePaths result;
|
||||||
|
|
||||||
for (auto & buildable : buildables) {
|
for (auto & buildable : buildables) {
|
||||||
std::visit(overloaded {
|
std::visit(overloaded {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include "installables.hh"
|
#include "installable-value.hh"
|
||||||
#include "args.hh"
|
#include "args.hh"
|
||||||
#include "common-eval-args.hh"
|
#include "common-eval-args.hh"
|
||||||
#include "path.hh"
|
#include "path.hh"
|
||||||
|
|
@ -18,17 +18,21 @@ class EvalState;
|
||||||
struct Pos;
|
struct Pos;
|
||||||
class Store;
|
class Store;
|
||||||
|
|
||||||
|
static constexpr Command::Category catHelp = -1;
|
||||||
static constexpr Command::Category catSecondary = 100;
|
static constexpr Command::Category catSecondary = 100;
|
||||||
static constexpr Command::Category catUtility = 101;
|
static constexpr Command::Category catUtility = 101;
|
||||||
static constexpr Command::Category catNixInstallation = 102;
|
static constexpr Command::Category catNixInstallation = 102;
|
||||||
|
|
||||||
static constexpr auto installablesCategory = "Options that change the interpretation of installables";
|
static constexpr auto installablesCategory = "Options that change the interpretation of [installables](@docroot@/command-ref/new-cli/nix.md#installables)";
|
||||||
|
|
||||||
struct NixMultiCommand : virtual MultiCommand, virtual Command
|
struct NixMultiCommand : virtual MultiCommand, virtual Command
|
||||||
{
|
{
|
||||||
nlohmann::json toJSON() override;
|
nlohmann::json toJSON() override;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// For the overloaded run methods
|
||||||
|
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
|
||||||
|
|
||||||
/* A command that requires a Nix store. */
|
/* A command that requires a Nix store. */
|
||||||
struct StoreCommand : virtual Command
|
struct StoreCommand : virtual Command
|
||||||
{
|
{
|
||||||
|
|
@ -97,10 +101,10 @@ struct SourceExprCommand : virtual Args, MixFlakeOptions
|
||||||
|
|
||||||
SourceExprCommand();
|
SourceExprCommand();
|
||||||
|
|
||||||
std::vector<std::shared_ptr<Installable>> parseInstallables(
|
Installables parseInstallables(
|
||||||
ref<Store> store, std::vector<std::string> ss);
|
ref<Store> store, std::vector<std::string> ss);
|
||||||
|
|
||||||
std::shared_ptr<Installable> parseInstallable(
|
ref<Installable> parseInstallable(
|
||||||
ref<Store> store, const std::string & installable);
|
ref<Store> store, const std::string & installable);
|
||||||
|
|
||||||
virtual Strings getDefaultFlakeAttrPaths();
|
virtual Strings getDefaultFlakeAttrPaths();
|
||||||
|
|
@ -115,34 +119,43 @@ struct MixReadOnlyOption : virtual Args
|
||||||
MixReadOnlyOption();
|
MixReadOnlyOption();
|
||||||
};
|
};
|
||||||
|
|
||||||
/* A command that operates on a list of "installables", which can be
|
/* Like InstallablesCommand but the installables are not loaded */
|
||||||
store paths, attribute paths, Nix expressions, etc. */
|
struct RawInstallablesCommand : virtual Args, SourceExprCommand
|
||||||
struct InstallablesCommand : virtual Args, SourceExprCommand
|
|
||||||
{
|
{
|
||||||
std::vector<std::shared_ptr<Installable>> installables;
|
RawInstallablesCommand();
|
||||||
|
|
||||||
InstallablesCommand();
|
virtual void run(ref<Store> store, std::vector<std::string> && rawInstallables) = 0;
|
||||||
|
|
||||||
void prepare() override;
|
void run(ref<Store> store) override;
|
||||||
Installables load();
|
|
||||||
|
|
||||||
virtual bool useDefaultInstallables() { return true; }
|
// FIXME make const after CmdRepl's override is fixed up
|
||||||
|
virtual void applyDefaultInstallables(std::vector<std::string> & rawInstallables);
|
||||||
|
|
||||||
|
bool readFromStdIn = false;
|
||||||
|
|
||||||
std::vector<std::string> getFlakesForCompletion() override;
|
std::vector<std::string> getFlakesForCompletion() override;
|
||||||
|
|
||||||
protected:
|
private:
|
||||||
|
|
||||||
std::vector<std::string> _installables;
|
std::vector<std::string> rawInstallables;
|
||||||
|
};
|
||||||
|
/* A command that operates on a list of "installables", which can be
|
||||||
|
store paths, attribute paths, Nix expressions, etc. */
|
||||||
|
struct InstallablesCommand : RawInstallablesCommand
|
||||||
|
{
|
||||||
|
virtual void run(ref<Store> store, Installables && installables) = 0;
|
||||||
|
|
||||||
|
void run(ref<Store> store, std::vector<std::string> && rawInstallables) override;
|
||||||
};
|
};
|
||||||
|
|
||||||
/* A command that operates on exactly one "installable" */
|
/* A command that operates on exactly one "installable" */
|
||||||
struct InstallableCommand : virtual Args, SourceExprCommand
|
struct InstallableCommand : virtual Args, SourceExprCommand
|
||||||
{
|
{
|
||||||
std::shared_ptr<Installable> installable;
|
|
||||||
|
|
||||||
InstallableCommand();
|
InstallableCommand();
|
||||||
|
|
||||||
void prepare() override;
|
virtual void run(ref<Store> store, ref<Installable> installable) = 0;
|
||||||
|
|
||||||
|
void run(ref<Store> store) override;
|
||||||
|
|
||||||
std::vector<std::string> getFlakesForCompletion() override
|
std::vector<std::string> getFlakesForCompletion() override
|
||||||
{
|
{
|
||||||
|
|
@ -177,22 +190,18 @@ public:
|
||||||
|
|
||||||
BuiltPathsCommand(bool recursive = false);
|
BuiltPathsCommand(bool recursive = false);
|
||||||
|
|
||||||
using StoreCommand::run;
|
|
||||||
|
|
||||||
virtual void run(ref<Store> store, BuiltPaths && paths) = 0;
|
virtual void run(ref<Store> store, BuiltPaths && paths) = 0;
|
||||||
|
|
||||||
void run(ref<Store> store) override;
|
void run(ref<Store> store, Installables && installables) override;
|
||||||
|
|
||||||
bool useDefaultInstallables() override { return !all; }
|
void applyDefaultInstallables(std::vector<std::string> & rawInstallables) override;
|
||||||
};
|
};
|
||||||
|
|
||||||
struct StorePathsCommand : public BuiltPathsCommand
|
struct StorePathsCommand : public BuiltPathsCommand
|
||||||
{
|
{
|
||||||
StorePathsCommand(bool recursive = false);
|
StorePathsCommand(bool recursive = false);
|
||||||
|
|
||||||
using BuiltPathsCommand::run;
|
virtual void run(ref<Store> store, StorePaths && storePaths) = 0;
|
||||||
|
|
||||||
virtual void run(ref<Store> store, std::vector<StorePath> && storePaths) = 0;
|
|
||||||
|
|
||||||
void run(ref<Store> store, BuiltPaths && paths) override;
|
void run(ref<Store> store, BuiltPaths && paths) override;
|
||||||
};
|
};
|
||||||
|
|
@ -200,11 +209,9 @@ struct StorePathsCommand : public BuiltPathsCommand
|
||||||
/* A command that operates on exactly one store path. */
|
/* A command that operates on exactly one store path. */
|
||||||
struct StorePathCommand : public StorePathsCommand
|
struct StorePathCommand : public StorePathsCommand
|
||||||
{
|
{
|
||||||
using StorePathsCommand::run;
|
|
||||||
|
|
||||||
virtual void run(ref<Store> store, const StorePath & storePath) = 0;
|
virtual void run(ref<Store> store, const StorePath & storePath) = 0;
|
||||||
|
|
||||||
void run(ref<Store> store, std::vector<StorePath> && storePaths) override;
|
void run(ref<Store> store, StorePaths && storePaths) override;
|
||||||
};
|
};
|
||||||
|
|
||||||
/* A helper class for registering commands globally. */
|
/* A helper class for registering commands globally. */
|
||||||
|
|
|
||||||
|
|
@ -136,7 +136,11 @@ MixEvalArgs::MixEvalArgs()
|
||||||
|
|
||||||
addFlag({
|
addFlag({
|
||||||
.longName = "eval-store",
|
.longName = "eval-store",
|
||||||
.description = "The Nix store to use for evaluations.",
|
.description =
|
||||||
|
R"(
|
||||||
|
The [URL of the Nix store](@docroot@/command-ref/new-cli/nix3-help-stores.md#store-url-format)
|
||||||
|
to use for evaluation, i.e. to store derivations (`.drv` files) and inputs referenced by them.
|
||||||
|
)",
|
||||||
.category = category,
|
.category = category,
|
||||||
.labels = {"store-url"},
|
.labels = {"store-url"},
|
||||||
.handler = {&evalStoreUrl},
|
.handler = {&evalStoreUrl},
|
||||||
|
|
@ -166,7 +170,7 @@ Path lookupFileArg(EvalState & state, std::string_view s)
|
||||||
}
|
}
|
||||||
|
|
||||||
else if (hasPrefix(s, "flake:")) {
|
else if (hasPrefix(s, "flake:")) {
|
||||||
settings.requireExperimentalFeature(Xp::Flakes);
|
experimentalFeatureSettings.require(Xp::Flakes);
|
||||||
auto flakeRef = parseFlakeRef(std::string(s.substr(6)), {}, true, false);
|
auto flakeRef = parseFlakeRef(std::string(s.substr(6)), {}, true, false);
|
||||||
auto storePath = flakeRef.resolve(state.store).fetchTree(state.store).first.storePath;
|
auto storePath = flakeRef.resolve(state.store).fetchTree(state.store).first.storePath;
|
||||||
return state.store->toRealPath(storePath);
|
return state.store->toRealPath(storePath);
|
||||||
|
|
|
||||||
|
|
@ -87,6 +87,10 @@ DerivedPathsWithInfo InstallableAttrPath::toDerivedPaths()
|
||||||
.drvPath = drvPath,
|
.drvPath = drvPath,
|
||||||
.outputs = outputs,
|
.outputs = outputs,
|
||||||
},
|
},
|
||||||
|
.info = make_ref<ExtraPathInfoValue>(ExtraPathInfoValue::Value {
|
||||||
|
/* FIXME: reconsider backwards compatibility above
|
||||||
|
so we can fill in this info. */
|
||||||
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
return res;
|
return res;
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,10 @@ std::string InstallableDerivedPath::what() const
|
||||||
|
|
||||||
DerivedPathsWithInfo InstallableDerivedPath::toDerivedPaths()
|
DerivedPathsWithInfo InstallableDerivedPath::toDerivedPaths()
|
||||||
{
|
{
|
||||||
return {{.path = derivedPath, .info = {} }};
|
return {{
|
||||||
|
.path = derivedPath,
|
||||||
|
.info = make_ref<ExtraPathInfo>(),
|
||||||
|
}};
|
||||||
}
|
}
|
||||||
|
|
||||||
std::optional<StorePath> InstallableDerivedPath::getStorePath()
|
std::optional<StorePath> InstallableDerivedPath::getStorePath()
|
||||||
|
|
@ -31,27 +34,24 @@ InstallableDerivedPath InstallableDerivedPath::parse(
|
||||||
ExtendedOutputsSpec extendedOutputsSpec)
|
ExtendedOutputsSpec extendedOutputsSpec)
|
||||||
{
|
{
|
||||||
auto derivedPath = std::visit(overloaded {
|
auto derivedPath = std::visit(overloaded {
|
||||||
// If the user did not use ^, we treat the output more liberally.
|
// If the user did not use ^, we treat the output more
|
||||||
|
// liberally: we accept a symlink chain or an actual
|
||||||
|
// store path.
|
||||||
[&](const ExtendedOutputsSpec::Default &) -> DerivedPath {
|
[&](const ExtendedOutputsSpec::Default &) -> DerivedPath {
|
||||||
// First, we accept a symlink chain or an actual store path.
|
|
||||||
auto storePath = store->followLinksToStorePath(prefix);
|
auto storePath = store->followLinksToStorePath(prefix);
|
||||||
// Second, we see if the store path ends in `.drv` to decide what sort
|
// Remove this prior to stabilizing the new CLI.
|
||||||
// of derived path they want.
|
if (storePath.isDerivation()) {
|
||||||
//
|
auto oldDerivedPath = DerivedPath::Built {
|
||||||
// This handling predates the `^` syntax. The `^*` in
|
.drvPath = storePath,
|
||||||
// `/nix/store/hash-foo.drv^*` unambiguously means "do the
|
.outputs = OutputsSpec::All { },
|
||||||
// `DerivedPath::Built` case", so plain `/nix/store/hash-foo.drv` could
|
|
||||||
// also unambiguously mean "do the DerivedPath::Opaque` case".
|
|
||||||
//
|
|
||||||
// Issue #7261 tracks reconsidering this `.drv` dispatching.
|
|
||||||
return storePath.isDerivation()
|
|
||||||
? (DerivedPath) DerivedPath::Built {
|
|
||||||
.drvPath = std::move(storePath),
|
|
||||||
.outputs = OutputsSpec::All {},
|
|
||||||
}
|
|
||||||
: (DerivedPath) DerivedPath::Opaque {
|
|
||||||
.path = std::move(storePath),
|
|
||||||
};
|
};
|
||||||
|
warn(
|
||||||
|
"The interpretation of store paths arguments ending in `.drv` recently changed. If this command is now failing try again with '%s'",
|
||||||
|
oldDerivedPath.to_string(*store));
|
||||||
|
};
|
||||||
|
return DerivedPath::Opaque {
|
||||||
|
.path = std::move(storePath),
|
||||||
|
};
|
||||||
},
|
},
|
||||||
// If the user did use ^, we just do exactly what is written.
|
// If the user did use ^, we just do exactly what is written.
|
||||||
[&](const ExtendedOutputsSpec::Explicit & outputSpec) -> DerivedPath {
|
[&](const ExtendedOutputsSpec::Explicit & outputSpec) -> DerivedPath {
|
||||||
|
|
|
||||||
|
|
@ -101,7 +101,8 @@ DerivedPathsWithInfo InstallableFlake::toDerivedPaths()
|
||||||
return {{
|
return {{
|
||||||
.path = DerivedPath::Opaque {
|
.path = DerivedPath::Opaque {
|
||||||
.path = std::move(storePath),
|
.path = std::move(storePath),
|
||||||
}
|
},
|
||||||
|
.info = make_ref<ExtraPathInfo>(),
|
||||||
}};
|
}};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -113,7 +114,8 @@ DerivedPathsWithInfo InstallableFlake::toDerivedPaths()
|
||||||
return {{
|
return {{
|
||||||
.path = DerivedPath::Opaque {
|
.path = DerivedPath::Opaque {
|
||||||
.path = std::move(*storePath),
|
.path = std::move(*storePath),
|
||||||
}
|
},
|
||||||
|
.info = make_ref<ExtraPathInfo>(),
|
||||||
}};
|
}};
|
||||||
} else
|
} else
|
||||||
throw Error("flake output attribute '%s' evaluates to the string '%s' which is not a store path", attrPath, s);
|
throw Error("flake output attribute '%s' evaluates to the string '%s' which is not a store path", attrPath, s);
|
||||||
|
|
@ -160,13 +162,16 @@ DerivedPathsWithInfo InstallableFlake::toDerivedPaths()
|
||||||
},
|
},
|
||||||
}, extendedOutputsSpec.raw()),
|
}, extendedOutputsSpec.raw()),
|
||||||
},
|
},
|
||||||
.info = {
|
.info = make_ref<ExtraPathInfoFlake>(
|
||||||
.priority = priority,
|
ExtraPathInfoValue::Value {
|
||||||
.originalRef = flakeRef,
|
.priority = priority,
|
||||||
.resolvedRef = getLockedFlake()->flake.lockedRef,
|
.attrPath = attrPath,
|
||||||
.attrPath = attrPath,
|
.extendedOutputsSpec = extendedOutputsSpec,
|
||||||
.extendedOutputsSpec = extendedOutputsSpec,
|
},
|
||||||
}
|
ExtraPathInfoFlake::Flake {
|
||||||
|
.originalRef = flakeRef,
|
||||||
|
.resolvedRef = getLockedFlake()->flake.lockedRef,
|
||||||
|
}),
|
||||||
}};
|
}};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -178,8 +183,7 @@ std::pair<Value *, PosIdx> InstallableFlake::toValue(EvalState & state)
|
||||||
std::vector<ref<eval_cache::AttrCursor>>
|
std::vector<ref<eval_cache::AttrCursor>>
|
||||||
InstallableFlake::getCursors(EvalState & state)
|
InstallableFlake::getCursors(EvalState & state)
|
||||||
{
|
{
|
||||||
auto evalCache = openEvalCache(state,
|
auto evalCache = openEvalCache(state, getLockedFlake());
|
||||||
std::make_shared<flake::LockedFlake>(lockFlake(state, flakeRef, lockFlags)));
|
|
||||||
|
|
||||||
auto root = evalCache->getRoot();
|
auto root = evalCache->getRoot();
|
||||||
|
|
||||||
|
|
@ -213,6 +217,7 @@ std::shared_ptr<flake::LockedFlake> InstallableFlake::getLockedFlake() const
|
||||||
{
|
{
|
||||||
if (!_lockedFlake) {
|
if (!_lockedFlake) {
|
||||||
flake::LockFlags lockFlagsApplyConfig = lockFlags;
|
flake::LockFlags lockFlagsApplyConfig = lockFlags;
|
||||||
|
// FIXME why this side effect?
|
||||||
lockFlagsApplyConfig.applyNixConfig = true;
|
lockFlagsApplyConfig.applyNixConfig = true;
|
||||||
_lockedFlake = std::make_shared<flake::LockedFlake>(lockFlake(*state, flakeRef, lockFlagsApplyConfig));
|
_lockedFlake = std::make_shared<flake::LockedFlake>(lockFlake(*state, flakeRef, lockFlagsApplyConfig));
|
||||||
}
|
}
|
||||||
|
|
@ -230,7 +235,7 @@ FlakeRef InstallableFlake::nixpkgsFlakeRef() const
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return Installable::nixpkgsFlakeRef();
|
return InstallableValue::nixpkgsFlakeRef();
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,30 @@
|
||||||
|
|
||||||
namespace nix {
|
namespace nix {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extra info about a \ref DerivedPath "derived path" that ultimately
|
||||||
|
* come from a Flake.
|
||||||
|
*
|
||||||
|
* Invariant: every ExtraPathInfo gotten from an InstallableFlake should
|
||||||
|
* be possible to downcast to an ExtraPathInfoFlake.
|
||||||
|
*/
|
||||||
|
struct ExtraPathInfoFlake : ExtraPathInfoValue
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Extra struct to get around C++ designated initializer limitations
|
||||||
|
*/
|
||||||
|
struct Flake {
|
||||||
|
FlakeRef originalRef;
|
||||||
|
FlakeRef resolvedRef;
|
||||||
|
};
|
||||||
|
|
||||||
|
Flake flake;
|
||||||
|
|
||||||
|
ExtraPathInfoFlake(Value && v, Flake && f)
|
||||||
|
: ExtraPathInfoValue(std::move(v)), flake(f)
|
||||||
|
{ }
|
||||||
|
};
|
||||||
|
|
||||||
struct InstallableFlake : InstallableValue
|
struct InstallableFlake : InstallableValue
|
||||||
{
|
{
|
||||||
FlakeRef flakeRef;
|
FlakeRef flakeRef;
|
||||||
|
|
@ -33,8 +57,10 @@ struct InstallableFlake : InstallableValue
|
||||||
|
|
||||||
std::pair<Value *, PosIdx> toValue(EvalState & state) override;
|
std::pair<Value *, PosIdx> toValue(EvalState & state) override;
|
||||||
|
|
||||||
/* Get a cursor to every attrpath in getActualAttrPaths()
|
/**
|
||||||
that exists. However if none exists, throw an exception. */
|
* Get a cursor to every attrpath in getActualAttrPaths() that
|
||||||
|
* exists. However if none exists, throw an exception.
|
||||||
|
*/
|
||||||
std::vector<ref<eval_cache::AttrCursor>>
|
std::vector<ref<eval_cache::AttrCursor>>
|
||||||
getCursors(EvalState & state) override;
|
getCursors(EvalState & state) override;
|
||||||
|
|
||||||
|
|
|
||||||
44
src/libcmd/installable-value.cc
Normal file
44
src/libcmd/installable-value.cc
Normal file
|
|
@ -0,0 +1,44 @@
|
||||||
|
#include "installable-value.hh"
|
||||||
|
#include "eval-cache.hh"
|
||||||
|
|
||||||
|
namespace nix {
|
||||||
|
|
||||||
|
std::vector<ref<eval_cache::AttrCursor>>
|
||||||
|
InstallableValue::getCursors(EvalState & state)
|
||||||
|
{
|
||||||
|
auto evalCache =
|
||||||
|
std::make_shared<nix::eval_cache::EvalCache>(std::nullopt, state,
|
||||||
|
[&]() { return toValue(state).first; });
|
||||||
|
return {evalCache->getRoot()};
|
||||||
|
}
|
||||||
|
|
||||||
|
ref<eval_cache::AttrCursor>
|
||||||
|
InstallableValue::getCursor(EvalState & state)
|
||||||
|
{
|
||||||
|
/* Although getCursors should return at least one element, in case it doesn't,
|
||||||
|
bound check to avoid an undefined behavior for vector[0] */
|
||||||
|
return getCursors(state).at(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
static UsageError nonValueInstallable(Installable & installable)
|
||||||
|
{
|
||||||
|
return UsageError("installable '%s' does not correspond to a Nix language value", installable.what());
|
||||||
|
}
|
||||||
|
|
||||||
|
InstallableValue & InstallableValue::require(Installable & installable)
|
||||||
|
{
|
||||||
|
auto * castedInstallable = dynamic_cast<InstallableValue *>(&installable);
|
||||||
|
if (!castedInstallable)
|
||||||
|
throw nonValueInstallable(installable);
|
||||||
|
return *castedInstallable;
|
||||||
|
}
|
||||||
|
|
||||||
|
ref<InstallableValue> InstallableValue::require(ref<Installable> installable)
|
||||||
|
{
|
||||||
|
auto castedInstallable = installable.dynamic_pointer_cast<InstallableValue>();
|
||||||
|
if (!castedInstallable)
|
||||||
|
throw nonValueInstallable(*installable);
|
||||||
|
return ref { castedInstallable };
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -1,14 +1,107 @@
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include "installables.hh"
|
#include "installables.hh"
|
||||||
|
#include "flake/flake.hh"
|
||||||
|
|
||||||
namespace nix {
|
namespace nix {
|
||||||
|
|
||||||
|
struct DrvInfo;
|
||||||
|
struct SourceExprCommand;
|
||||||
|
|
||||||
|
namespace eval_cache { class EvalCache; class AttrCursor; }
|
||||||
|
|
||||||
|
struct App
|
||||||
|
{
|
||||||
|
std::vector<DerivedPath> context;
|
||||||
|
Path program;
|
||||||
|
// FIXME: add args, sandbox settings, metadata, ...
|
||||||
|
};
|
||||||
|
|
||||||
|
struct UnresolvedApp
|
||||||
|
{
|
||||||
|
App unresolved;
|
||||||
|
App resolve(ref<Store> evalStore, ref<Store> store);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extra info about a \ref DerivedPath "derived path" that ultimately
|
||||||
|
* come from a Nix language value.
|
||||||
|
*
|
||||||
|
* Invariant: every ExtraPathInfo gotten from an InstallableValue should
|
||||||
|
* be possible to downcast to an ExtraPathInfoValue.
|
||||||
|
*/
|
||||||
|
struct ExtraPathInfoValue : ExtraPathInfo
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Extra struct to get around C++ designated initializer limitations
|
||||||
|
*/
|
||||||
|
struct Value {
|
||||||
|
/**
|
||||||
|
* An optional priority for use with "build envs". See Package
|
||||||
|
*/
|
||||||
|
std::optional<NixInt> priority;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The attribute path associated with this value. The idea is
|
||||||
|
* that an installable referring to a value typically refers to
|
||||||
|
* a larger value, from which we project a smaller value out
|
||||||
|
* with this.
|
||||||
|
*/
|
||||||
|
std::string attrPath;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \todo merge with DerivedPath's 'outputs' field?
|
||||||
|
*/
|
||||||
|
ExtendedOutputsSpec extendedOutputsSpec;
|
||||||
|
};
|
||||||
|
|
||||||
|
Value value;
|
||||||
|
|
||||||
|
ExtraPathInfoValue(Value && v)
|
||||||
|
: value(v)
|
||||||
|
{ }
|
||||||
|
|
||||||
|
virtual ~ExtraPathInfoValue() = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An Installable which corresponds a Nix langauge value, in addition to
|
||||||
|
* a collection of \ref DerivedPath "derived paths".
|
||||||
|
*/
|
||||||
struct InstallableValue : Installable
|
struct InstallableValue : Installable
|
||||||
{
|
{
|
||||||
ref<EvalState> state;
|
ref<EvalState> state;
|
||||||
|
|
||||||
InstallableValue(ref<EvalState> state) : state(state) {}
|
InstallableValue(ref<EvalState> state) : state(state) {}
|
||||||
|
|
||||||
|
virtual ~InstallableValue() { }
|
||||||
|
|
||||||
|
virtual std::pair<Value *, PosIdx> toValue(EvalState & state) = 0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a cursor to each value this Installable could refer to.
|
||||||
|
* However if none exists, throw exception instead of returning
|
||||||
|
* empty vector.
|
||||||
|
*/
|
||||||
|
virtual std::vector<ref<eval_cache::AttrCursor>>
|
||||||
|
getCursors(EvalState & state);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the first and most preferred cursor this Installable could
|
||||||
|
* refer to, or throw an exception if none exists.
|
||||||
|
*/
|
||||||
|
virtual ref<eval_cache::AttrCursor>
|
||||||
|
getCursor(EvalState & state);
|
||||||
|
|
||||||
|
UnresolvedApp toApp(EvalState & state);
|
||||||
|
|
||||||
|
virtual FlakeRef nixpkgsFlakeRef() const
|
||||||
|
{
|
||||||
|
return FlakeRef::fromAttrs({{"type","indirect"}, {"id", "nixpkgs"}});
|
||||||
|
}
|
||||||
|
|
||||||
|
static InstallableValue & require(Installable & installable);
|
||||||
|
static ref<InstallableValue> require(ref<Installable> installable);
|
||||||
};
|
};
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -153,7 +153,7 @@ SourceExprCommand::SourceExprCommand()
|
||||||
.longName = "file",
|
.longName = "file",
|
||||||
.shortName = 'f',
|
.shortName = 'f',
|
||||||
.description =
|
.description =
|
||||||
"Interpret installables as attribute paths relative to the Nix expression stored in *file*. "
|
"Interpret [*installables*](@docroot@/command-ref/new-cli/nix.md#installables) as attribute paths relative to the Nix expression stored in *file*. "
|
||||||
"If *file* is the character -, then a Nix expression will be read from standard input. "
|
"If *file* is the character -, then a Nix expression will be read from standard input. "
|
||||||
"Implies `--impure`.",
|
"Implies `--impure`.",
|
||||||
.category = installablesCategory,
|
.category = installablesCategory,
|
||||||
|
|
@ -164,7 +164,7 @@ SourceExprCommand::SourceExprCommand()
|
||||||
|
|
||||||
addFlag({
|
addFlag({
|
||||||
.longName = "expr",
|
.longName = "expr",
|
||||||
.description = "Interpret installables as attribute paths relative to the Nix expression *expr*.",
|
.description = "Interpret [*installables*](@docroot@/command-ref/new-cli/nix.md#installables) as attribute paths relative to the Nix expression *expr*.",
|
||||||
.category = installablesCategory,
|
.category = installablesCategory,
|
||||||
.labels = {"expr"},
|
.labels = {"expr"},
|
||||||
.handler = {&expr}
|
.handler = {&expr}
|
||||||
|
|
@ -332,7 +332,7 @@ void completeFlakeRefWithFragment(
|
||||||
|
|
||||||
void completeFlakeRef(ref<Store> store, std::string_view prefix)
|
void completeFlakeRef(ref<Store> store, std::string_view prefix)
|
||||||
{
|
{
|
||||||
if (!settings.isExperimentalFeatureEnabled(Xp::Flakes))
|
if (!experimentalFeatureSettings.isEnabled(Xp::Flakes))
|
||||||
return;
|
return;
|
||||||
|
|
||||||
if (prefix == "")
|
if (prefix == "")
|
||||||
|
|
@ -364,23 +364,6 @@ DerivedPathWithInfo Installable::toDerivedPath()
|
||||||
return std::move(buildables[0]);
|
return std::move(buildables[0]);
|
||||||
}
|
}
|
||||||
|
|
||||||
std::vector<ref<eval_cache::AttrCursor>>
|
|
||||||
Installable::getCursors(EvalState & state)
|
|
||||||
{
|
|
||||||
auto evalCache =
|
|
||||||
std::make_shared<nix::eval_cache::EvalCache>(std::nullopt, state,
|
|
||||||
[&]() { return toValue(state).first; });
|
|
||||||
return {evalCache->getRoot()};
|
|
||||||
}
|
|
||||||
|
|
||||||
ref<eval_cache::AttrCursor>
|
|
||||||
Installable::getCursor(EvalState & state)
|
|
||||||
{
|
|
||||||
/* Although getCursors should return at least one element, in case it doesn't,
|
|
||||||
bound check to avoid an undefined behavior for vector[0] */
|
|
||||||
return getCursors(state).at(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
static StorePath getDeriver(
|
static StorePath getDeriver(
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
const Installable & i,
|
const Installable & i,
|
||||||
|
|
@ -422,10 +405,10 @@ ref<eval_cache::EvalCache> openEvalCache(
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
std::vector<std::shared_ptr<Installable>> SourceExprCommand::parseInstallables(
|
Installables SourceExprCommand::parseInstallables(
|
||||||
ref<Store> store, std::vector<std::string> ss)
|
ref<Store> store, std::vector<std::string> ss)
|
||||||
{
|
{
|
||||||
std::vector<std::shared_ptr<Installable>> result;
|
Installables result;
|
||||||
|
|
||||||
if (file || expr) {
|
if (file || expr) {
|
||||||
if (file && expr)
|
if (file && expr)
|
||||||
|
|
@ -451,7 +434,7 @@ std::vector<std::shared_ptr<Installable>> SourceExprCommand::parseInstallables(
|
||||||
for (auto & s : ss) {
|
for (auto & s : ss) {
|
||||||
auto [prefix, extendedOutputsSpec] = ExtendedOutputsSpec::parse(s);
|
auto [prefix, extendedOutputsSpec] = ExtendedOutputsSpec::parse(s);
|
||||||
result.push_back(
|
result.push_back(
|
||||||
std::make_shared<InstallableAttrPath>(
|
make_ref<InstallableAttrPath>(
|
||||||
InstallableAttrPath::parse(
|
InstallableAttrPath::parse(
|
||||||
state, *this, vFile, prefix, extendedOutputsSpec)));
|
state, *this, vFile, prefix, extendedOutputsSpec)));
|
||||||
}
|
}
|
||||||
|
|
@ -468,7 +451,7 @@ std::vector<std::shared_ptr<Installable>> SourceExprCommand::parseInstallables(
|
||||||
|
|
||||||
if (prefix.find('/') != std::string::npos) {
|
if (prefix.find('/') != std::string::npos) {
|
||||||
try {
|
try {
|
||||||
result.push_back(std::make_shared<InstallableDerivedPath>(
|
result.push_back(make_ref<InstallableDerivedPath>(
|
||||||
InstallableDerivedPath::parse(store, prefix, extendedOutputsSpec)));
|
InstallableDerivedPath::parse(store, prefix, extendedOutputsSpec)));
|
||||||
continue;
|
continue;
|
||||||
} catch (BadStorePath &) {
|
} catch (BadStorePath &) {
|
||||||
|
|
@ -480,7 +463,7 @@ std::vector<std::shared_ptr<Installable>> SourceExprCommand::parseInstallables(
|
||||||
|
|
||||||
try {
|
try {
|
||||||
auto [flakeRef, fragment] = parseFlakeRefWithFragment(std::string { prefix }, absPath("."));
|
auto [flakeRef, fragment] = parseFlakeRefWithFragment(std::string { prefix }, absPath("."));
|
||||||
result.push_back(std::make_shared<InstallableFlake>(
|
result.push_back(make_ref<InstallableFlake>(
|
||||||
this,
|
this,
|
||||||
getEvalState(),
|
getEvalState(),
|
||||||
std::move(flakeRef),
|
std::move(flakeRef),
|
||||||
|
|
@ -501,7 +484,7 @@ std::vector<std::shared_ptr<Installable>> SourceExprCommand::parseInstallables(
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
std::shared_ptr<Installable> SourceExprCommand::parseInstallable(
|
ref<Installable> SourceExprCommand::parseInstallable(
|
||||||
ref<Store> store, const std::string & installable)
|
ref<Store> store, const std::string & installable)
|
||||||
{
|
{
|
||||||
auto installables = parseInstallables(store, {installable});
|
auto installables = parseInstallables(store, {installable});
|
||||||
|
|
@ -513,7 +496,7 @@ std::vector<BuiltPathWithResult> Installable::build(
|
||||||
ref<Store> evalStore,
|
ref<Store> evalStore,
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables,
|
const Installables & installables,
|
||||||
BuildMode bMode)
|
BuildMode bMode)
|
||||||
{
|
{
|
||||||
std::vector<BuiltPathWithResult> res;
|
std::vector<BuiltPathWithResult> res;
|
||||||
|
|
@ -522,11 +505,11 @@ std::vector<BuiltPathWithResult> Installable::build(
|
||||||
return res;
|
return res;
|
||||||
}
|
}
|
||||||
|
|
||||||
std::vector<std::pair<std::shared_ptr<Installable>, BuiltPathWithResult>> Installable::build2(
|
std::vector<std::pair<ref<Installable>, BuiltPathWithResult>> Installable::build2(
|
||||||
ref<Store> evalStore,
|
ref<Store> evalStore,
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables,
|
const Installables & installables,
|
||||||
BuildMode bMode)
|
BuildMode bMode)
|
||||||
{
|
{
|
||||||
if (mode == Realise::Nothing)
|
if (mode == Realise::Nothing)
|
||||||
|
|
@ -534,8 +517,8 @@ std::vector<std::pair<std::shared_ptr<Installable>, BuiltPathWithResult>> Instal
|
||||||
|
|
||||||
struct Aux
|
struct Aux
|
||||||
{
|
{
|
||||||
ExtraPathInfo info;
|
ref<ExtraPathInfo> info;
|
||||||
std::shared_ptr<Installable> installable;
|
ref<Installable> installable;
|
||||||
};
|
};
|
||||||
|
|
||||||
std::vector<DerivedPath> pathsToBuild;
|
std::vector<DerivedPath> pathsToBuild;
|
||||||
|
|
@ -548,7 +531,7 @@ std::vector<std::pair<std::shared_ptr<Installable>, BuiltPathWithResult>> Instal
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
std::vector<std::pair<std::shared_ptr<Installable>, BuiltPathWithResult>> res;
|
std::vector<std::pair<ref<Installable>, BuiltPathWithResult>> res;
|
||||||
|
|
||||||
switch (mode) {
|
switch (mode) {
|
||||||
|
|
||||||
|
|
@ -620,7 +603,7 @@ BuiltPaths Installable::toBuiltPaths(
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
OperateOn operateOn,
|
OperateOn operateOn,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables)
|
const Installables & installables)
|
||||||
{
|
{
|
||||||
if (operateOn == OperateOn::Output) {
|
if (operateOn == OperateOn::Output) {
|
||||||
BuiltPaths res;
|
BuiltPaths res;
|
||||||
|
|
@ -642,7 +625,7 @@ StorePathSet Installable::toStorePaths(
|
||||||
ref<Store> evalStore,
|
ref<Store> evalStore,
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode, OperateOn operateOn,
|
Realise mode, OperateOn operateOn,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables)
|
const Installables & installables)
|
||||||
{
|
{
|
||||||
StorePathSet outPaths;
|
StorePathSet outPaths;
|
||||||
for (auto & path : toBuiltPaths(evalStore, store, mode, operateOn, installables)) {
|
for (auto & path : toBuiltPaths(evalStore, store, mode, operateOn, installables)) {
|
||||||
|
|
@ -656,7 +639,7 @@ StorePath Installable::toStorePath(
|
||||||
ref<Store> evalStore,
|
ref<Store> evalStore,
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode, OperateOn operateOn,
|
Realise mode, OperateOn operateOn,
|
||||||
std::shared_ptr<Installable> installable)
|
ref<Installable> installable)
|
||||||
{
|
{
|
||||||
auto paths = toStorePaths(evalStore, store, mode, operateOn, {installable});
|
auto paths = toStorePaths(evalStore, store, mode, operateOn, {installable});
|
||||||
|
|
||||||
|
|
@ -668,7 +651,7 @@ StorePath Installable::toStorePath(
|
||||||
|
|
||||||
StorePathSet Installable::toDerivations(
|
StorePathSet Installable::toDerivations(
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables,
|
const Installables & installables,
|
||||||
bool useDeriver)
|
bool useDeriver)
|
||||||
{
|
{
|
||||||
StorePathSet drvPaths;
|
StorePathSet drvPaths;
|
||||||
|
|
@ -677,9 +660,12 @@ StorePathSet Installable::toDerivations(
|
||||||
for (const auto & b : i->toDerivedPaths())
|
for (const auto & b : i->toDerivedPaths())
|
||||||
std::visit(overloaded {
|
std::visit(overloaded {
|
||||||
[&](const DerivedPath::Opaque & bo) {
|
[&](const DerivedPath::Opaque & bo) {
|
||||||
if (!useDeriver)
|
drvPaths.insert(
|
||||||
throw Error("argument '%s' did not evaluate to a derivation", i->what());
|
bo.path.isDerivation()
|
||||||
drvPaths.insert(getDeriver(store, *i, bo.path));
|
? bo.path
|
||||||
|
: useDeriver
|
||||||
|
? getDeriver(store, *i, bo.path)
|
||||||
|
: throw Error("argument '%s' did not evaluate to a derivation", i->what()));
|
||||||
},
|
},
|
||||||
[&](const DerivedPath::Built & bfd) {
|
[&](const DerivedPath::Built & bfd) {
|
||||||
drvPaths.insert(bfd.drvPath);
|
drvPaths.insert(bfd.drvPath);
|
||||||
|
|
@ -689,36 +675,55 @@ StorePathSet Installable::toDerivations(
|
||||||
return drvPaths;
|
return drvPaths;
|
||||||
}
|
}
|
||||||
|
|
||||||
InstallablesCommand::InstallablesCommand()
|
RawInstallablesCommand::RawInstallablesCommand()
|
||||||
{
|
{
|
||||||
|
addFlag({
|
||||||
|
.longName = "stdin",
|
||||||
|
.description = "Read installables from the standard input.",
|
||||||
|
.handler = {&readFromStdIn, true}
|
||||||
|
});
|
||||||
|
|
||||||
expectArgs({
|
expectArgs({
|
||||||
.label = "installables",
|
.label = "installables",
|
||||||
.handler = {&_installables},
|
.handler = {&rawInstallables},
|
||||||
.completer = {[&](size_t, std::string_view prefix) {
|
.completer = {[&](size_t, std::string_view prefix) {
|
||||||
completeInstallable(prefix);
|
completeInstallable(prefix);
|
||||||
}}
|
}}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
void InstallablesCommand::prepare()
|
void RawInstallablesCommand::applyDefaultInstallables(std::vector<std::string> & rawInstallables)
|
||||||
{
|
{
|
||||||
installables = load();
|
if (rawInstallables.empty()) {
|
||||||
}
|
|
||||||
|
|
||||||
Installables InstallablesCommand::load()
|
|
||||||
{
|
|
||||||
if (_installables.empty() && useDefaultInstallables())
|
|
||||||
// FIXME: commands like "nix profile install" should not have a
|
// FIXME: commands like "nix profile install" should not have a
|
||||||
// default, probably.
|
// default, probably.
|
||||||
_installables.push_back(".");
|
rawInstallables.push_back(".");
|
||||||
return parseInstallables(getStore(), _installables);
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
std::vector<std::string> InstallablesCommand::getFlakesForCompletion()
|
void RawInstallablesCommand::run(ref<Store> store)
|
||||||
{
|
{
|
||||||
if (_installables.empty() && useDefaultInstallables())
|
if (readFromStdIn && !isatty(STDIN_FILENO)) {
|
||||||
return {"."};
|
std::string word;
|
||||||
return _installables;
|
while (std::cin >> word) {
|
||||||
|
rawInstallables.emplace_back(std::move(word));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
applyDefaultInstallables(rawInstallables);
|
||||||
|
run(store, std::move(rawInstallables));
|
||||||
|
}
|
||||||
|
|
||||||
|
std::vector<std::string> RawInstallablesCommand::getFlakesForCompletion()
|
||||||
|
{
|
||||||
|
applyDefaultInstallables(rawInstallables);
|
||||||
|
return rawInstallables;
|
||||||
|
}
|
||||||
|
|
||||||
|
void InstallablesCommand::run(ref<Store> store, std::vector<std::string> && rawInstallables)
|
||||||
|
{
|
||||||
|
auto installables = parseInstallables(store, rawInstallables);
|
||||||
|
run(store, std::move(installables));
|
||||||
}
|
}
|
||||||
|
|
||||||
InstallableCommand::InstallableCommand()
|
InstallableCommand::InstallableCommand()
|
||||||
|
|
@ -734,9 +739,16 @@ InstallableCommand::InstallableCommand()
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
void InstallableCommand::prepare()
|
void InstallableCommand::run(ref<Store> store)
|
||||||
{
|
{
|
||||||
installable = parseInstallable(getStore(), _installable);
|
auto installable = parseInstallable(store, _installable);
|
||||||
|
run(store, std::move(installable));
|
||||||
|
}
|
||||||
|
|
||||||
|
void BuiltPathsCommand::applyDefaultInstallables(std::vector<std::string> & rawInstallables)
|
||||||
|
{
|
||||||
|
if (rawInstallables.empty() && !all)
|
||||||
|
rawInstallables.push_back(".");
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,9 +4,7 @@
|
||||||
#include "path.hh"
|
#include "path.hh"
|
||||||
#include "outputs-spec.hh"
|
#include "outputs-spec.hh"
|
||||||
#include "derived-path.hh"
|
#include "derived-path.hh"
|
||||||
#include "eval.hh"
|
|
||||||
#include "store-api.hh"
|
#include "store-api.hh"
|
||||||
#include "flake/flake.hh"
|
|
||||||
#include "build-result.hh"
|
#include "build-result.hh"
|
||||||
|
|
||||||
#include <optional>
|
#include <optional>
|
||||||
|
|
@ -14,122 +12,156 @@
|
||||||
namespace nix {
|
namespace nix {
|
||||||
|
|
||||||
struct DrvInfo;
|
struct DrvInfo;
|
||||||
struct SourceExprCommand;
|
|
||||||
|
|
||||||
namespace eval_cache { class EvalCache; class AttrCursor; }
|
|
||||||
|
|
||||||
struct App
|
|
||||||
{
|
|
||||||
std::vector<DerivedPath> context;
|
|
||||||
Path program;
|
|
||||||
// FIXME: add args, sandbox settings, metadata, ...
|
|
||||||
};
|
|
||||||
|
|
||||||
struct UnresolvedApp
|
|
||||||
{
|
|
||||||
App unresolved;
|
|
||||||
App resolve(ref<Store> evalStore, ref<Store> store);
|
|
||||||
};
|
|
||||||
|
|
||||||
enum class Realise {
|
enum class Realise {
|
||||||
/* Build the derivation. Postcondition: the
|
/**
|
||||||
derivation outputs exist. */
|
* Build the derivation.
|
||||||
|
*
|
||||||
|
* Postcondition: the derivation outputs exist.
|
||||||
|
*/
|
||||||
Outputs,
|
Outputs,
|
||||||
/* Don't build the derivation. Postcondition: the store derivation
|
/**
|
||||||
exists. */
|
* Don't build the derivation.
|
||||||
|
*
|
||||||
|
* Postcondition: the store derivation exists.
|
||||||
|
*/
|
||||||
Derivation,
|
Derivation,
|
||||||
/* Evaluate in dry-run mode. Postcondition: nothing. */
|
/**
|
||||||
// FIXME: currently unused, but could be revived if we can
|
* Evaluate in dry-run mode.
|
||||||
// evaluate derivations in-memory.
|
*
|
||||||
|
* Postcondition: nothing.
|
||||||
|
*
|
||||||
|
* \todo currently unused, but could be revived if we can evaluate
|
||||||
|
* derivations in-memory.
|
||||||
|
*/
|
||||||
Nothing
|
Nothing
|
||||||
};
|
};
|
||||||
|
|
||||||
/* How to handle derivations in commands that operate on store paths. */
|
/**
|
||||||
|
* How to handle derivations in commands that operate on store paths.
|
||||||
|
*/
|
||||||
enum class OperateOn {
|
enum class OperateOn {
|
||||||
/* Operate on the output path. */
|
/**
|
||||||
|
* Operate on the output path.
|
||||||
|
*/
|
||||||
Output,
|
Output,
|
||||||
/* Operate on the .drv path. */
|
/**
|
||||||
|
* Operate on the .drv path.
|
||||||
|
*/
|
||||||
Derivation
|
Derivation
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extra info about a DerivedPath
|
||||||
|
*
|
||||||
|
* Yes, this is empty, but that is intended. It will be sub-classed by
|
||||||
|
* the subclasses of Installable to allow those to provide more info.
|
||||||
|
* Certain commands will make use of this info.
|
||||||
|
*/
|
||||||
struct ExtraPathInfo
|
struct ExtraPathInfo
|
||||||
{
|
{
|
||||||
std::optional<NixInt> priority;
|
virtual ~ExtraPathInfo() = default;
|
||||||
std::optional<FlakeRef> originalRef;
|
|
||||||
std::optional<FlakeRef> resolvedRef;
|
|
||||||
std::optional<std::string> attrPath;
|
|
||||||
// FIXME: merge with DerivedPath's 'outputs' field?
|
|
||||||
std::optional<ExtendedOutputsSpec> extendedOutputsSpec;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/* A derived path with any additional info that commands might
|
/**
|
||||||
need from the derivation. */
|
* A DerivedPath with \ref ExtraPathInfo "any additional info" that
|
||||||
|
* commands might need from the derivation.
|
||||||
|
*/
|
||||||
struct DerivedPathWithInfo
|
struct DerivedPathWithInfo
|
||||||
{
|
{
|
||||||
DerivedPath path;
|
DerivedPath path;
|
||||||
ExtraPathInfo info;
|
ref<ExtraPathInfo> info;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Like DerivedPathWithInfo but extending BuiltPath with \ref
|
||||||
|
* ExtraPathInfo "extra info" and also possibly the \ref BuildResult
|
||||||
|
* "result of building".
|
||||||
|
*/
|
||||||
struct BuiltPathWithResult
|
struct BuiltPathWithResult
|
||||||
{
|
{
|
||||||
BuiltPath path;
|
BuiltPath path;
|
||||||
ExtraPathInfo info;
|
ref<ExtraPathInfo> info;
|
||||||
std::optional<BuildResult> result;
|
std::optional<BuildResult> result;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shorthand, for less typing and helping us keep the choice of
|
||||||
|
* collection in sync.
|
||||||
|
*/
|
||||||
typedef std::vector<DerivedPathWithInfo> DerivedPathsWithInfo;
|
typedef std::vector<DerivedPathWithInfo> DerivedPathsWithInfo;
|
||||||
|
|
||||||
|
struct Installable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shorthand, for less typing and helping us keep the choice of
|
||||||
|
* collection in sync.
|
||||||
|
*/
|
||||||
|
typedef std::vector<ref<Installable>> Installables;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Installables are the main positional arguments for the Nix
|
||||||
|
* Command-line.
|
||||||
|
*
|
||||||
|
* This base class is very flexible, and just assumes and the
|
||||||
|
* Installable refers to a collection of \ref DerivedPath "derived paths" with
|
||||||
|
* \ref ExtraPathInfo "extra info".
|
||||||
|
*/
|
||||||
struct Installable
|
struct Installable
|
||||||
{
|
{
|
||||||
virtual ~Installable() { }
|
virtual ~Installable() { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What Installable is this?
|
||||||
|
*
|
||||||
|
* Prints back valid CLI syntax that would result in this same
|
||||||
|
* installable. It doesn't need to be exactly what the user wrote,
|
||||||
|
* just something that means the same thing.
|
||||||
|
*/
|
||||||
virtual std::string what() const = 0;
|
virtual std::string what() const = 0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the collection of \ref DerivedPathWithInfo "derived paths
|
||||||
|
* with info" that this \ref Installable instalallable denotes.
|
||||||
|
*
|
||||||
|
* This is the main method of this class
|
||||||
|
*/
|
||||||
virtual DerivedPathsWithInfo toDerivedPaths() = 0;
|
virtual DerivedPathsWithInfo toDerivedPaths() = 0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A convenience wrapper of the above for when we expect an
|
||||||
|
* installable to produce a single \ref DerivedPath "derived path"
|
||||||
|
* only.
|
||||||
|
*
|
||||||
|
* If no or multiple \ref DerivedPath "derived paths" are produced,
|
||||||
|
* and error is raised.
|
||||||
|
*/
|
||||||
DerivedPathWithInfo toDerivedPath();
|
DerivedPathWithInfo toDerivedPath();
|
||||||
|
|
||||||
UnresolvedApp toApp(EvalState & state);
|
/**
|
||||||
|
* Return a value only if this installable is a store path or a
|
||||||
virtual std::pair<Value *, PosIdx> toValue(EvalState & state)
|
* symlink to it.
|
||||||
{
|
*
|
||||||
throw Error("argument '%s' cannot be evaluated", what());
|
* \todo should we move this to InstallableDerivedPath? It is only
|
||||||
}
|
* supposed to work there anyways. Can always downcast.
|
||||||
|
*/
|
||||||
/* Return a value only if this installable is a store path or a
|
|
||||||
symlink to it. */
|
|
||||||
virtual std::optional<StorePath> getStorePath()
|
virtual std::optional<StorePath> getStorePath()
|
||||||
{
|
{
|
||||||
return {};
|
return {};
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Get a cursor to each value this Installable could refer to. However
|
|
||||||
if none exists, throw exception instead of returning empty vector. */
|
|
||||||
virtual std::vector<ref<eval_cache::AttrCursor>>
|
|
||||||
getCursors(EvalState & state);
|
|
||||||
|
|
||||||
/* Get the first and most preferred cursor this Installable could refer
|
|
||||||
to, or throw an exception if none exists. */
|
|
||||||
virtual ref<eval_cache::AttrCursor>
|
|
||||||
getCursor(EvalState & state);
|
|
||||||
|
|
||||||
virtual FlakeRef nixpkgsFlakeRef() const
|
|
||||||
{
|
|
||||||
return FlakeRef::fromAttrs({{"type","indirect"}, {"id", "nixpkgs"}});
|
|
||||||
}
|
|
||||||
|
|
||||||
static std::vector<BuiltPathWithResult> build(
|
static std::vector<BuiltPathWithResult> build(
|
||||||
ref<Store> evalStore,
|
ref<Store> evalStore,
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables,
|
const Installables & installables,
|
||||||
BuildMode bMode = bmNormal);
|
BuildMode bMode = bmNormal);
|
||||||
|
|
||||||
static std::vector<std::pair<std::shared_ptr<Installable>, BuiltPathWithResult>> build2(
|
static std::vector<std::pair<ref<Installable>, BuiltPathWithResult>> build2(
|
||||||
ref<Store> evalStore,
|
ref<Store> evalStore,
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables,
|
const Installables & installables,
|
||||||
BuildMode bMode = bmNormal);
|
BuildMode bMode = bmNormal);
|
||||||
|
|
||||||
static std::set<StorePath> toStorePaths(
|
static std::set<StorePath> toStorePaths(
|
||||||
|
|
@ -137,18 +169,18 @@ struct Installable
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
OperateOn operateOn,
|
OperateOn operateOn,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables);
|
const Installables & installables);
|
||||||
|
|
||||||
static StorePath toStorePath(
|
static StorePath toStorePath(
|
||||||
ref<Store> evalStore,
|
ref<Store> evalStore,
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
OperateOn operateOn,
|
OperateOn operateOn,
|
||||||
std::shared_ptr<Installable> installable);
|
ref<Installable> installable);
|
||||||
|
|
||||||
static std::set<StorePath> toDerivations(
|
static std::set<StorePath> toDerivations(
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables,
|
const Installables & installables,
|
||||||
bool useDeriver = false);
|
bool useDeriver = false);
|
||||||
|
|
||||||
static BuiltPaths toBuiltPaths(
|
static BuiltPaths toBuiltPaths(
|
||||||
|
|
@ -156,9 +188,7 @@ struct Installable
|
||||||
ref<Store> store,
|
ref<Store> store,
|
||||||
Realise mode,
|
Realise mode,
|
||||||
OperateOn operateOn,
|
OperateOn operateOn,
|
||||||
const std::vector<std::shared_ptr<Installable>> & installables);
|
const Installables & installables);
|
||||||
};
|
};
|
||||||
|
|
||||||
typedef std::vector<std::shared_ptr<Installable>> Installables;
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,7 @@
|
||||||
#include "eval-inline.hh"
|
#include "eval-inline.hh"
|
||||||
#include "filetransfer.hh"
|
#include "filetransfer.hh"
|
||||||
#include "function-trace.hh"
|
#include "function-trace.hh"
|
||||||
|
#include "profiles.hh"
|
||||||
|
|
||||||
#include <algorithm>
|
#include <algorithm>
|
||||||
#include <chrono>
|
#include <chrono>
|
||||||
|
|
@ -368,7 +369,7 @@ void initGC()
|
||||||
size = (pageSize * pages) / 4; // 25% of RAM
|
size = (pageSize * pages) / 4; // 25% of RAM
|
||||||
if (size > maxSize) size = maxSize;
|
if (size > maxSize) size = maxSize;
|
||||||
#endif
|
#endif
|
||||||
debug(format("setting initial heap size to %1% bytes") % size);
|
debug("setting initial heap size to %1% bytes", size);
|
||||||
GC_expand_hp(size);
|
GC_expand_hp(size);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -609,7 +610,7 @@ Path EvalState::checkSourcePath(const Path & path_)
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Resolve symlinks. */
|
/* Resolve symlinks. */
|
||||||
debug(format("checking access to '%s'") % abspath);
|
debug("checking access to '%s'", abspath);
|
||||||
Path path = canonPath(abspath, true);
|
Path path = canonPath(abspath, true);
|
||||||
|
|
||||||
for (auto & i : *allowedPaths) {
|
for (auto & i : *allowedPaths) {
|
||||||
|
|
@ -2491,8 +2492,8 @@ Strings EvalSettings::getDefaultNixPath()
|
||||||
|
|
||||||
if (!evalSettings.restrictEval && !evalSettings.pureEval) {
|
if (!evalSettings.restrictEval && !evalSettings.pureEval) {
|
||||||
add(settings.useXDGBaseDirectories ? getStateDir() + "/nix/defexpr/channels" : getHome() + "/.nix-defexpr/channels");
|
add(settings.useXDGBaseDirectories ? getStateDir() + "/nix/defexpr/channels" : getHome() + "/.nix-defexpr/channels");
|
||||||
add(settings.nixStateDir + "/profiles/per-user/root/channels/nixpkgs", "nixpkgs");
|
add(rootChannelsDir() + "/nixpkgs", "nixpkgs");
|
||||||
add(settings.nixStateDir + "/profiles/per-user/root/channels");
|
add(rootChannelsDir());
|
||||||
}
|
}
|
||||||
|
|
||||||
return res;
|
return res;
|
||||||
|
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue