diff options
author | Alyssa Ross <hi@alyssa.is> | 2023-12-15 19:32:38 +0100 |
---|---|---|
committer | Alyssa Ross <hi@alyssa.is> | 2023-12-15 19:32:38 +0100 |
commit | 6b8e2555ef013b579cda57025b17d662e0f1fe1f (patch) | |
tree | 5a83c673af26c9976acd5a5dfa20e09e06898047 /nixpkgs/doc | |
parent | 66ca7a150b5c051f0728f13134e6265cc46f370c (diff) | |
parent | 02357adddd0889782362d999628de9d309d202dc (diff) | |
download | nixlib-6b8e2555ef013b579cda57025b17d662e0f1fe1f.tar nixlib-6b8e2555ef013b579cda57025b17d662e0f1fe1f.tar.gz nixlib-6b8e2555ef013b579cda57025b17d662e0f1fe1f.tar.bz2 nixlib-6b8e2555ef013b579cda57025b17d662e0f1fe1f.tar.lz nixlib-6b8e2555ef013b579cda57025b17d662e0f1fe1f.tar.xz nixlib-6b8e2555ef013b579cda57025b17d662e0f1fe1f.tar.zst nixlib-6b8e2555ef013b579cda57025b17d662e0f1fe1f.zip |
Merge branch 'nixos-unstable-small' of https://github.com/NixOS/nixpkgs
Diffstat (limited to 'nixpkgs/doc')
-rw-r--r-- | nixpkgs/doc/README.md | 18 | ||||
-rw-r--r-- | nixpkgs/doc/languages-frameworks/cuda.section.md | 47 | ||||
-rw-r--r-- | nixpkgs/doc/languages-frameworks/nim.section.md | 17 | ||||
-rw-r--r-- | nixpkgs/doc/languages-frameworks/rust.section.md | 3 | ||||
-rw-r--r-- | nixpkgs/doc/manpage-urls.json | 290 | ||||
-rw-r--r-- | nixpkgs/doc/manual.md.in | 2 | ||||
-rw-r--r-- | nixpkgs/doc/preface.chapter.md | 14 |
7 files changed, 362 insertions, 29 deletions
diff --git a/nixpkgs/doc/README.md b/nixpkgs/doc/README.md index 9dee2d30d730..616409beaaf5 100644 --- a/nixpkgs/doc/README.md +++ b/nixpkgs/doc/README.md @@ -1,13 +1,17 @@ -# Contributing to the Nixpkgs manual +# Contributing to the Nixpkgs reference manual -This directory houses the sources files for the Nixpkgs manual. +This directory houses the sources files for the Nixpkgs reference manual. -You can find the [rendered documentation for Nixpkgs `unstable` on nixos.org](https://nixos.org/manual/nixpkgs/unstable/). -The rendering tool is [nixos-render-docs](../pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs), sometimes abbreviated `nrd`. +Going forward, it should only contain [reference](https://nix.dev/contributing/documentation/diataxis#reference) documentation. +For tutorials, guides and explanations, contribute to <https://nix.dev/> instead. + +For documentation only relevant for contributors, use Markdown files and code comments in the source code. -[Docs for Nixpkgs stable](https://nixos.org/manual/nixpkgs/stable/) are also available. +Rendered documentation: +- [Unstable (from master)](https://nixos.org/manual/nixpkgs/unstable/) +- [Stable (from latest release)](https://nixos.org/manual/nixpkgs/stable/) -If you're only getting started with Nix, go to [nixos.org/learn](https://nixos.org/learn). +The rendering tool is [nixos-render-docs](../pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs), sometimes abbreviated `nrd`. ## Contributing to this documentation @@ -48,7 +52,7 @@ It uses the widely compatible [header attributes](https://github.com/jgm/commonm ## Syntax {#sec-contributing-markup} ``` -> **Note** +> [!Note] > NixOS option documentation does not support headings in general. #### Inline Anchors diff --git a/nixpkgs/doc/languages-frameworks/cuda.section.md b/nixpkgs/doc/languages-frameworks/cuda.section.md index 01a4f20da982..11c86e375c61 100644 --- a/nixpkgs/doc/languages-frameworks/cuda.section.md +++ b/nixpkgs/doc/languages-frameworks/cuda.section.md @@ -68,16 +68,45 @@ All new projects should use the CUDA redistributables available in [`cudaPackage ### Updating CUDA redistributables {#updating-cuda-redistributables} 1. Go to NVIDIA's index of CUDA redistributables: <https://developer.download.nvidia.com/compute/cuda/redist/> -2. Copy the `redistrib_*.json` corresponding to the release to `pkgs/development/compilers/cudatoolkit/redist/manifests`. -3. Generate the `redistrib_features_*.json` file by running: +2. Make a note of the new version of CUDA available. +3. Run - ```bash - nix run github:ConnorBaker/cuda-redist-find-features -- <path to manifest> - ``` + ```bash + nix run github:connorbaker/cuda-redist-find-features -- \ + download-manifests \ + --log-level DEBUG \ + --version <newest CUDA version> \ + https://developer.download.nvidia.com/compute/cuda/redist \ + ./pkgs/development/cuda-modules/cuda/manifests + ``` + + This will download a copy of the manifest for the new version of CUDA. +4. Run + + ```bash + nix run github:connorbaker/cuda-redist-find-features -- \ + process-manifests \ + --log-level DEBUG \ + --version <newest CUDA version> \ + https://developer.download.nvidia.com/compute/cuda/redist \ + ./pkgs/development/cuda-modules/cuda/manifests + ``` + + This will generate a `redistrib_features_<newest CUDA version>.json` file in the same directory as the manifest. +5. Update the `cudaVersionMap` attribute set in `pkgs/development/cuda-modules/cuda/extension.nix`. + +### Updating cuTensor {#updating-cutensor} + +1. Repeat the steps present in [Updating CUDA redistributables](#updating-cuda-redistributables) with the following changes: + - Use the index of cuTensor redistributables: <https://developer.download.nvidia.com/compute/cutensor/redist> + - Use the newest version of cuTensor available instead of the newest version of CUDA. + - Use `pkgs/development/cuda-modules/cutensor/manifests` instead of `pkgs/development/cuda-modules/cuda/manifests`. + - Skip the step of updating `cudaVersionMap` in `pkgs/development/cuda-modules/cuda/extension.nix`. - That command will generate the `redistrib_features_*.json` file in the same directory as the manifest. +### Updating supported compilers and GPUs {#updating-supported-compilers-and-gpus} -4. Include the path to the new manifest in `pkgs/development/compilers/cudatoolkit/redist/extension.nix`. +1. Update `nvcc-compatibilities.nix` in `pkgs/development/cuda-modules/` to include the newest release of NVCC, as well as any newly supported host compilers. +2. Update `gpus.nix` in `pkgs/development/cuda-modules/` to include any new GPUs supported by the new release of CUDA. ### Updating the CUDA Toolkit runfile installer {#updating-the-cuda-toolkit} @@ -99,7 +128,7 @@ All new projects should use the CUDA redistributables available in [`cudaPackage nix store prefetch-file --hash-type sha256 <link> ``` -4. Update `pkgs/development/compilers/cudatoolkit/versions.toml` to include the release. +4. Update `pkgs/development/cuda-modules/cudatoolkit/releases.nix` to include the release. ### Updating the CUDA package set {#updating-the-cuda-package-set} @@ -107,7 +136,7 @@ All new projects should use the CUDA redistributables available in [`cudaPackage - NOTE: Changing the default CUDA package set should occur in a separate PR, allowing time for additional testing. -2. Successfully build the closure of the new package set, updating `pkgs/development/compilers/cudatoolkit/redist/overrides.nix` as needed. Below are some common failures: +2. Successfully build the closure of the new package set, updating `pkgs/development/cuda-modules/cuda/overrides.nix` as needed. Below are some common failures: | Unable to ... | During ... | Reason | Solution | Note | | --- | --- | --- | --- | --- | diff --git a/nixpkgs/doc/languages-frameworks/nim.section.md b/nixpkgs/doc/languages-frameworks/nim.section.md index 45cd07b3a3d8..c6ebf49b83f6 100644 --- a/nixpkgs/doc/languages-frameworks/nim.section.md +++ b/nixpkgs/doc/languages-frameworks/nim.section.md @@ -50,7 +50,20 @@ $ nix build -f . ttop.src $ nix run -f . nim_lk ./result | jq --sort-keys > pkgs/by-name/tt/ttop/lock.json ``` -## Lockfile dependency overrides {#nimoverrides} +## Overriding Nim packages {#nim-overrides} + +The `buildNimPackage` function generates flags and additional build dependencies from the `lockFile` parameter passed to `buildNimPackage`. Using [`overrideAttrs`](#sec-pkg-overrideAttrs) on the final package will apply after this has already been generated, so this can't be used to override the `lockFile` in a package built with `buildNimPackage`. To be able to override parameters before flags and build dependencies are generated from the `lockFile`, use `overrideNimAttrs` instead with the same syntax as `overrideAttrs`: + +```nix +pkgs.nitter.overrideNimAttrs { + # using a different source which has different dependencies from the standard package + src = pkgs.fetchFromGithub { /* … */ }; + # new lock file generated from the source + lockFile = ./custom-lock.json; +} +``` + +## Lockfile dependency overrides {#nim-lock-overrides} The `buildNimPackage` function matches the libraries specified by `lockFile` to attrset of override functions that are then applied to the package derivation. The default overrides are maintained as the top-level `nimOverrides` attrset at `pkgs/top-level/nim-overrides.nix`. @@ -81,7 +94,7 @@ The annotations in the `nim-overrides.nix` set are functions that take three arg - finalAttrs: the final attrset passed by `buildNimPackage` to `stdenv.mkDerivation`. - prevAttrs: the attrset produced by initial arguments to `buildNimPackage` and any preceding lockfile overlays. -### Overriding an Nim library override {#nimoverrides-overrides} +### Overriding an Nim library override {#nim-lock-overrides-overrides} The `nimOverrides` attrset makes it possible to modify overrides in a few different ways. diff --git a/nixpkgs/doc/languages-frameworks/rust.section.md b/nixpkgs/doc/languages-frameworks/rust.section.md index d18b048b911b..9be381c0bfe2 100644 --- a/nixpkgs/doc/languages-frameworks/rust.section.md +++ b/nixpkgs/doc/languages-frameworks/rust.section.md @@ -963,7 +963,7 @@ repository: lib.updateManyAttrsByPath [{ path = [ "packages" "stable" ]; update = old: old.overrideScope(final: prev: { - rustc = prev.rustc.overrideAttrs (_: { + rustc-unwrapped = prev.rustc-unwrapped.overrideAttrs (_: { src = lib.cleanSource /git/scratch/rust; # do *not* put passthru.isReleaseTarball=true here }); @@ -1003,4 +1003,3 @@ nix-build $NIXPKGS -A package-broken-by-rust-changes The `git submodule update --init` and `cargo vendor` commands above require network access, so they can't be performed from within the `rustc` derivation, unfortunately. - diff --git a/nixpkgs/doc/manpage-urls.json b/nixpkgs/doc/manpage-urls.json index a5064c8fcb5e..71bee5c7a6ea 100644 --- a/nixpkgs/doc/manpage-urls.json +++ b/nixpkgs/doc/manpage-urls.json @@ -6,29 +6,313 @@ "portals.conf(5)": "https://github.com/flatpak/xdg-desktop-portal/blob/1.18.1/doc/portals.conf.rst.in", + "bootctl(1)": "https://www.freedesktop.org/software/systemd/man/bootctl.html", + "busctl(1)": "https://www.freedesktop.org/software/systemd/man/busctl.html", + "coredumpctl(1)": "https://www.freedesktop.org/software/systemd/man/coredumpctl.html", + "homectl(1)": "https://www.freedesktop.org/software/systemd/man/homectl.html", + "hostnamectl(1)": "https://www.freedesktop.org/software/systemd/man/hostnamectl.html", + "init(1)": "https://www.freedesktop.org/software/systemd/man/init.html", + "journalctl(1)": "https://www.freedesktop.org/software/systemd/man/journalctl.html", + "localectl(1)": "https://www.freedesktop.org/software/systemd/man/localectl.html", + "loginctl(1)": "https://www.freedesktop.org/software/systemd/man/loginctl.html", + "machinectl(1)": "https://www.freedesktop.org/software/systemd/man/machinectl.html", + "mount.ddi(1)": "https://www.freedesktop.org/software/systemd/man/mount.ddi.html", + "networkctl(1)": "https://www.freedesktop.org/software/systemd/man/networkctl.html", + "oomctl(1)": "https://www.freedesktop.org/software/systemd/man/oomctl.html", + "portablectl(1)": "https://www.freedesktop.org/software/systemd/man/portablectl.html", + "resolvconf(1)": "https://www.freedesktop.org/software/systemd/man/resolvconf.html", + "resolvectl(1)": "https://www.freedesktop.org/software/systemd/man/resolvectl.html", + "systemctl(1)": "https://www.freedesktop.org/software/systemd/man/systemctl.html", + "systemd-ac-power(1)": "https://www.freedesktop.org/software/systemd/man/systemd-ac-power.html", + "systemd-analyze(1)": "https://www.freedesktop.org/software/systemd/man/systemd-analyze.html", + "systemd-ask-password(1)": "https://www.freedesktop.org/software/systemd/man/systemd-ask-password.html", + "systemd-cat(1)": "https://www.freedesktop.org/software/systemd/man/systemd-cat.html", + "systemd-cgls(1)": "https://www.freedesktop.org/software/systemd/man/systemd-cgls.html", + "systemd-cgtop(1)": "https://www.freedesktop.org/software/systemd/man/systemd-cgtop.html", + "systemd-creds(1)": "https://www.freedesktop.org/software/systemd/man/systemd-creds.html", + "systemd-cryptenroll(1)": "https://www.freedesktop.org/software/systemd/man/systemd-cryptenroll.html", + "systemd-delta(1)": "https://www.freedesktop.org/software/systemd/man/systemd-delta.html", + "systemd-detect-virt(1)": "https://www.freedesktop.org/software/systemd/man/systemd-detect-virt.html", + "systemd-dissect(1)": "https://www.freedesktop.org/software/systemd/man/systemd-dissect.html", + "systemd-escape(1)": "https://www.freedesktop.org/software/systemd/man/systemd-escape.html", + "systemd-id128(1)": "https://www.freedesktop.org/software/systemd/man/systemd-id128.html", + "systemd-inhibit(1)": "https://www.freedesktop.org/software/systemd/man/systemd-inhibit.html", + "systemd-machine-id-setup(1)": "https://www.freedesktop.org/software/systemd/man/systemd-machine-id-setup.html", + "systemd-measure(1)": "https://www.freedesktop.org/software/systemd/man/systemd-measure.html", + "systemd-mount(1)": "https://www.freedesktop.org/software/systemd/man/systemd-mount.html", + "systemd-notify(1)": "https://www.freedesktop.org/software/systemd/man/systemd-notify.html", + "systemd-nspawn(1)": "https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html", + "systemd-path(1)": "https://www.freedesktop.org/software/systemd/man/systemd-path.html", + "systemd-run(1)": "https://www.freedesktop.org/software/systemd/man/systemd-run.html", + "systemd-socket-activate(1)": "https://www.freedesktop.org/software/systemd/man/systemd-socket-activate.html", + "systemd-stdio-bridge(1)": "https://www.freedesktop.org/software/systemd/man/systemd-stdio-bridge.html", + "systemd-tty-ask-password-agent(1)": "https://www.freedesktop.org/software/systemd/man/systemd-tty-ask-password-agent.html", + "systemd-umount(1)": "https://www.freedesktop.org/software/systemd/man/systemd-umount.html", + "systemd(1)": "https://www.freedesktop.org/software/systemd/man/systemd.html", + "timedatectl(1)": "https://www.freedesktop.org/software/systemd/man/timedatectl.html", + "userdbctl(1)": "https://www.freedesktop.org/software/systemd/man/userdbctl.html", + "binfmt.d(5)": "https://www.freedesktop.org/software/systemd/man/binfmt.d.html", + "coredump.conf(5)": "https://www.freedesktop.org/software/systemd/man/coredump.conf.html", + "coredump.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/coredump.conf.d.html", + "crypttab(5)": "https://www.freedesktop.org/software/systemd/man/crypttab.html", + "dnssec-trust-anchors.d(5)": "https://www.freedesktop.org/software/systemd/man/dnssec-trust-anchors.d.html", + "environment.d(5)": "https://www.freedesktop.org/software/systemd/man/environment.d.html", + "extension-release(5)": "https://www.freedesktop.org/software/systemd/man/extension-release.html", + "homed.conf(5)": "https://www.freedesktop.org/software/systemd/man/homed.conf.html", + "homed.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/homed.conf.d.html", + "hostname(5)": "https://www.freedesktop.org/software/systemd/man/hostname.html", + "initrd-release(5)": "https://www.freedesktop.org/software/systemd/man/initrd-release.html", + "integritytab(5)": "https://www.freedesktop.org/software/systemd/man/integritytab.html", + "iocost.conf(5)": "https://www.freedesktop.org/software/systemd/man/iocost.conf.html", + "journal-remote.conf(5)": "https://www.freedesktop.org/software/systemd/man/journal-remote.conf.html", + "journal-remote.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/journal-remote.conf.d.html", + "journal-upload.conf(5)": "https://www.freedesktop.org/software/systemd/man/journal-upload.conf.html", + "journal-upload.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/journal-upload.conf.d.html", "journald.conf(5)": "https://www.freedesktop.org/software/systemd/man/journald.conf.html", + "journald.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/journald.conf.d.html", + "journald@.conf(5)": "https://www.freedesktop.org/software/systemd/man/journald@.conf.html", + "loader.conf(5)": "https://www.freedesktop.org/software/systemd/man/loader.conf.html", + "locale.conf(5)": "https://www.freedesktop.org/software/systemd/man/locale.conf.html", + "localtime(5)": "https://www.freedesktop.org/software/systemd/man/localtime.html", "logind.conf(5)": "https://www.freedesktop.org/software/systemd/man/logind.conf.html", + "logind.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/logind.conf.d.html", + "machine-id(5)": "https://www.freedesktop.org/software/systemd/man/machine-id.html", + "machine-info(5)": "https://www.freedesktop.org/software/systemd/man/machine-info.html", + "modules-load.d(5)": "https://www.freedesktop.org/software/systemd/man/modules-load.d.html", "networkd.conf(5)": "https://www.freedesktop.org/software/systemd/man/networkd.conf.html", + "networkd.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/networkd.conf.d.html", + "oomd.conf(5)": "https://www.freedesktop.org/software/systemd/man/oomd.conf.html", + "oomd.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/oomd.conf.d.html", + "org.freedesktop.LogControl1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.LogControl1.html", + "org.freedesktop.home1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.home1.html", + "org.freedesktop.hostname1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.hostname1.html", + "org.freedesktop.import1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.import1.html", + "org.freedesktop.locale1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.locale1.html", + "org.freedesktop.login1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.login1.html", + "org.freedesktop.machine1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.machine1.html", + "org.freedesktop.network1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.network1.html", + "org.freedesktop.oom1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.oom1.html", + "org.freedesktop.portable1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.portable1.html", + "org.freedesktop.resolve1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.resolve1.html", + "org.freedesktop.systemd1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.systemd1.html", + "org.freedesktop.timedate1(5)": "https://www.freedesktop.org/software/systemd/man/org.freedesktop.timedate1.html", + "os-release(5)": "https://www.freedesktop.org/software/systemd/man/os-release.html", + "pstore.conf(5)": "https://www.freedesktop.org/software/systemd/man/pstore.conf.html", + "pstore.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/pstore.conf.d.html", + "repart.d(5)": "https://www.freedesktop.org/software/systemd/man/repart.d.html", + "resolved.conf(5)": "https://www.freedesktop.org/software/systemd/man/resolved.conf.html", + "resolved.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/resolved.conf.d.html", + "sleep.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/sleep.conf.d.html", + "sysctl.d(5)": "https://www.freedesktop.org/software/systemd/man/sysctl.d.html", + "system.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/system.conf.d.html", + "systemd-sleep.conf(5)": "https://www.freedesktop.org/software/systemd/man/systemd-sleep.conf.html", + "systemd-system.conf(5)": "https://www.freedesktop.org/software/systemd/man/systemd-system.conf.html", + "systemd-user-runtime-dir(5)": "https://www.freedesktop.org/software/systemd/man/systemd-user-runtime-dir.html", + "systemd-user.conf(5)": "https://www.freedesktop.org/software/systemd/man/systemd-user.conf.html", "systemd.automount(5)": "https://www.freedesktop.org/software/systemd/man/systemd.automount.html", + "systemd.device(5)": "https://www.freedesktop.org/software/systemd/man/systemd.device.html", + "systemd.dnssd(5)": "https://www.freedesktop.org/software/systemd/man/systemd.dnssd.html", "systemd.exec(5)": "https://www.freedesktop.org/software/systemd/man/systemd.exec.html", + "systemd.kill(5)": "https://www.freedesktop.org/software/systemd/man/systemd.kill.html", "systemd.link(5)": "https://www.freedesktop.org/software/systemd/man/systemd.link.html", "systemd.mount(5)": "https://www.freedesktop.org/software/systemd/man/systemd.mount.html", + "systemd.negative(5)": "https://www.freedesktop.org/software/systemd/man/systemd.negative.html", "systemd.netdev(5)": "https://www.freedesktop.org/software/systemd/man/systemd.netdev.html", "systemd.network(5)": "https://www.freedesktop.org/software/systemd/man/systemd.network.html", "systemd.nspawn(5)": "https://www.freedesktop.org/software/systemd/man/systemd.nspawn.html", "systemd.path(5)": "https://www.freedesktop.org/software/systemd/man/systemd.path.html", + "systemd.positive(5)": "https://www.freedesktop.org/software/systemd/man/systemd.positive.html", + "systemd.preset(5)": "https://www.freedesktop.org/software/systemd/man/systemd.preset.html", "systemd.resource-control(5)": "https://www.freedesktop.org/software/systemd/man/systemd.resource-control.html", "systemd.scope(5)": "https://www.freedesktop.org/software/systemd/man/systemd.scope.html", "systemd.service(5)": "https://www.freedesktop.org/software/systemd/man/systemd.service.html", "systemd.slice(5)": "https://www.freedesktop.org/software/systemd/man/systemd.slice.html", "systemd.socket(5)": "https://www.freedesktop.org/software/systemd/man/systemd.socket.html", + "systemd.swap(5)": "https://www.freedesktop.org/software/systemd/man/systemd.swap.html", + "systemd.target(5)": "https://www.freedesktop.org/software/systemd/man/systemd.target.html", "systemd.timer(5)": "https://www.freedesktop.org/software/systemd/man/systemd.timer.html", "systemd.unit(5)": "https://www.freedesktop.org/software/systemd/man/systemd.unit.html", - "systemd-system.conf(5)": "https://www.freedesktop.org/software/systemd/man/systemd-system.conf.html", - "systemd-user.conf(5)": "https://www.freedesktop.org/software/systemd/man/systemd-user.conf.html", + "sysupdate.d(5)": "https://www.freedesktop.org/software/systemd/man/sysupdate.d.html", + "sysusers.d(5)": "https://www.freedesktop.org/software/systemd/man/sysusers.d.html", "timesyncd.conf(5)": "https://www.freedesktop.org/software/systemd/man/timesyncd.conf.html", + "timesyncd.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/timesyncd.conf.d.html", "tmpfiles.d(5)": "https://www.freedesktop.org/software/systemd/man/tmpfiles.d.html", + "udev.conf(5)": "https://www.freedesktop.org/software/systemd/man/udev.conf.html", + "user-runtime-dir@.service(5)": "https://www.freedesktop.org/software/systemd/man/user-runtime-dir@.service.html", + "user.conf.d(5)": "https://www.freedesktop.org/software/systemd/man/user.conf.d.html", + "user@.service(5)": "https://www.freedesktop.org/software/systemd/man/user@.service.html", + "vconsole.conf(5)": "https://www.freedesktop.org/software/systemd/man/vconsole.conf.html", + "veritytab(5)": "https://www.freedesktop.org/software/systemd/man/veritytab.html", + "bootup(7)": "https://www.freedesktop.org/software/systemd/man/bootup.html", + "daemon(7)": "https://www.freedesktop.org/software/systemd/man/daemon.html", + "file-hierarchy(7)": "https://www.freedesktop.org/software/systemd/man/file-hierarchy.html", + "hwdb(7)": "https://www.freedesktop.org/software/systemd/man/hwdb.html", + "kernel-command-line(7)": "https://www.freedesktop.org/software/systemd/man/kernel-command-line.html", + "linuxaa64.efi.stub(7)": "https://www.freedesktop.org/software/systemd/man/linuxaa64.efi.stub.html", + "linuxia32.efi.stub(7)": "https://www.freedesktop.org/software/systemd/man/linuxia32.efi.stub.html", + "linuxx64.efi.stub(7)": "https://www.freedesktop.org/software/systemd/man/linuxx64.efi.stub.html", + "sd-boot(7)": "https://www.freedesktop.org/software/systemd/man/sd-boot.html", + "sd-stub(7)": "https://www.freedesktop.org/software/systemd/man/sd-stub.html", + "smbios-type-11(7)": "https://www.freedesktop.org/software/systemd/man/smbios-type-11.html", + "systemd-boot(7)": "https://www.freedesktop.org/software/systemd/man/systemd-boot.html", + "systemd-stub(7)": "https://www.freedesktop.org/software/systemd/man/systemd-stub.html", + "systemd.directives(7)": "https://www.freedesktop.org/software/systemd/man/systemd.directives.html", + "systemd.environment-generator(7)": "https://www.freedesktop.org/software/systemd/man/systemd.environment-generator.html", + "systemd.generator(7)": "https://www.freedesktop.org/software/systemd/man/systemd.generator.html", + "systemd.image-policy(7)": "https://www.freedesktop.org/software/systemd/man/systemd.image-policy.html", + "systemd.index(7)": "https://www.freedesktop.org/software/systemd/man/systemd.index.html", + "systemd.journal-fields(7)": "https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html", + "systemd.net-naming-scheme(7)": "https://www.freedesktop.org/software/systemd/man/systemd.net-naming-scheme.html", + "systemd.offline-updates(7)": "https://www.freedesktop.org/software/systemd/man/systemd.offline-updates.html", + "systemd.special(7)": "https://www.freedesktop.org/software/systemd/man/systemd.special.html", + "systemd.syntax(7)": "https://www.freedesktop.org/software/systemd/man/systemd.syntax.html", + "systemd.system-credentials(7)": "https://www.freedesktop.org/software/systemd/man/systemd.system-credentials.html", "systemd.time(7)": "https://www.freedesktop.org/software/systemd/man/systemd.time.html", + "udev(7)": "https://www.freedesktop.org/software/systemd/man/udev.html", + "30-systemd-environment-d-generator(8)": "https://www.freedesktop.org/software/systemd/man/30-systemd-environment-d-generator.html", + "halt(8)": "https://www.freedesktop.org/software/systemd/man/halt.html", + "kernel-install(8)": "https://www.freedesktop.org/software/systemd/man/kernel-install.html", + "libnss_myhostname.so.2(8)": "https://www.freedesktop.org/software/systemd/man/libnss_myhostname.so.2.html", + "libnss_mymachines.so.2(8)": "https://www.freedesktop.org/software/systemd/man/libnss_mymachines.so.2.html", + "libnss_resolve.so.2(8)": "https://www.freedesktop.org/software/systemd/man/libnss_resolve.so.2.html", + "libnss_systemd.so.2(8)": "https://www.freedesktop.org/software/systemd/man/libnss_systemd.so.2.html", + "nss-myhostname(8)": "https://www.freedesktop.org/software/systemd/man/nss-myhostname.html", + "nss-mymachines(8)": "https://www.freedesktop.org/software/systemd/man/nss-mymachines.html", + "nss-resolve(8)": "https://www.freedesktop.org/software/systemd/man/nss-resolve.html", + "nss-systemd(8)": "https://www.freedesktop.org/software/systemd/man/nss-systemd.html", + "pam_systemd(8)": "https://www.freedesktop.org/software/systemd/man/pam_systemd.html", + "pam_systemd_home(8)": "https://www.freedesktop.org/software/systemd/man/pam_systemd_home.html", + "poweroff(8)": "https://www.freedesktop.org/software/systemd/man/poweroff.html", + "reboot(8)": "https://www.freedesktop.org/software/systemd/man/reboot.html", + "shutdown(8)": "https://www.freedesktop.org/software/systemd/man/shutdown.html", + "systemd-ask-password-console.path(8)": "https://www.freedesktop.org/software/systemd/man/systemd-ask-password-console.path.html", + "systemd-ask-password-console.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-ask-password-console.service.html", + "systemd-ask-password-wall.path(8)": "https://www.freedesktop.org/software/systemd/man/systemd-ask-password-wall.path.html", + "systemd-ask-password-wall.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-ask-password-wall.service.html", + "systemd-backlight(8)": "https://www.freedesktop.org/software/systemd/man/systemd-backlight.html", + "systemd-backlight@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-backlight@.service.html", + "systemd-battery-check(8)": "https://www.freedesktop.org/software/systemd/man/systemd-battery-check.html", + "systemd-binfmt(8)": "https://www.freedesktop.org/software/systemd/man/systemd-binfmt.html", + "systemd-bless-boot-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-bless-boot-generator.html", + "systemd-bless-boot(8)": "https://www.freedesktop.org/software/systemd/man/systemd-bless-boot.html", + "systemd-boot-check-no-failures(8)": "https://www.freedesktop.org/software/systemd/man/systemd-boot-check-no-failures.html", + "systemd-boot-random-seed.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-boot-random-seed.service.html", + "systemd-confext(8)": "https://www.freedesktop.org/software/systemd/man/systemd-confext.html", + "systemd-confext.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-confext.service.html", + "systemd-coredump(8)": "https://www.freedesktop.org/software/systemd/man/systemd-coredump.html", + "systemd-coredump.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-coredump.socket.html", + "systemd-coredump@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-coredump@.service.html", + "systemd-cryptsetup-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-cryptsetup-generator.html", + "systemd-cryptsetup(8)": "https://www.freedesktop.org/software/systemd/man/systemd-cryptsetup.html", + "systemd-cryptsetup@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-cryptsetup@.service.html", + "systemd-debug-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-debug-generator.html", + "systemd-environment-d-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-environment-d-generator.html", + "systemd-fsck-root.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-fsck-root.service.html", + "systemd-fsck-usr.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-fsck-usr.service.html", + "systemd-fsck(8)": "https://www.freedesktop.org/software/systemd/man/systemd-fsck.html", + "systemd-fsck@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-fsck@.service.html", "systemd-fstab-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-fstab-generator.html", - "systemd-networkd-wait-online.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online.service.html" + "systemd-getty-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-getty-generator.html", + "systemd-gpt-auto-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-gpt-auto-generator.html", + "systemd-growfs-root.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-growfs-root.service.html", + "systemd-growfs(8)": "https://www.freedesktop.org/software/systemd/man/systemd-growfs.html", + "systemd-growfs@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-growfs@.service.html", + "systemd-halt.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-halt.service.html", + "systemd-hibernate-resume-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-hibernate-resume-generator.html", + "systemd-hibernate-resume(8)": "https://www.freedesktop.org/software/systemd/man/systemd-hibernate-resume.html", + "systemd-hibernate.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-hibernate.service.html", + "systemd-homed(8)": "https://www.freedesktop.org/software/systemd/man/systemd-homed.html", + "systemd-hostnamed(8)": "https://www.freedesktop.org/software/systemd/man/systemd-hostnamed.html", + "systemd-hwdb(8)": "https://www.freedesktop.org/software/systemd/man/systemd-hwdb.html", + "systemd-hybrid-sleep.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-hybrid-sleep.service.html", + "systemd-importd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-importd.html", + "systemd-integritysetup-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-integritysetup-generator.html", + "systemd-integritysetup(8)": "https://www.freedesktop.org/software/systemd/man/systemd-integritysetup.html", + "systemd-integritysetup@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-integritysetup@.service.html", + "systemd-journal-gatewayd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journal-gatewayd.html", + "systemd-journal-gatewayd.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journal-gatewayd.socket.html", + "systemd-journal-remote(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journal-remote.html", + "systemd-journal-remote.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journal-remote.socket.html", + "systemd-journal-upload(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journal-upload.html", + "systemd-journald-audit.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journald-audit.socket.html", + "systemd-journald-dev-log.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journald-dev-log.socket.html", + "systemd-journald-varlink@.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journald-varlink@.socket.html", + "systemd-journald(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journald.html", + "systemd-journald.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journald.socket.html", + "systemd-journald@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journald@.service.html", + "systemd-journald@.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-journald@.socket.html", + "systemd-kexec.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-kexec.service.html", + "systemd-localed(8)": "https://www.freedesktop.org/software/systemd/man/systemd-localed.html", + "systemd-logind(8)": "https://www.freedesktop.org/software/systemd/man/systemd-logind.html", + "systemd-machine-id-commit.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-machine-id-commit.service.html", + "systemd-machined(8)": "https://www.freedesktop.org/software/systemd/man/systemd-machined.html", + "systemd-makefs(8)": "https://www.freedesktop.org/software/systemd/man/systemd-makefs.html", + "systemd-makefs@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-makefs@.service.html", + "systemd-mkswap@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-mkswap@.service.html", + "systemd-modules-load(8)": "https://www.freedesktop.org/software/systemd/man/systemd-modules-load.html", + "systemd-network-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-network-generator.html", + "systemd-networkd-wait-online(8)": "https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online.html", + "systemd-networkd-wait-online@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online@.service.html", + "systemd-networkd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-networkd.html", + "systemd-oomd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-oomd.html", + "systemd-pcrfs-root.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-pcrfs-root.service.html", + "systemd-pcrfs@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-pcrfs@.service.html", + "systemd-pcrmachine.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-pcrmachine.service.html", + "systemd-pcrphase-initrd.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-pcrphase-initrd.service.html", + "systemd-pcrphase-sysinit.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-pcrphase-sysinit.service.html", + "systemd-pcrphase(8)": "https://www.freedesktop.org/software/systemd/man/systemd-pcrphase.html", + "systemd-portabled(8)": "https://www.freedesktop.org/software/systemd/man/systemd-portabled.html", + "systemd-poweroff.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-poweroff.service.html", + "systemd-pstore(8)": "https://www.freedesktop.org/software/systemd/man/systemd-pstore.html", + "systemd-random-seed(8)": "https://www.freedesktop.org/software/systemd/man/systemd-random-seed.html", + "systemd-reboot.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-reboot.service.html", + "systemd-remount-fs(8)": "https://www.freedesktop.org/software/systemd/man/systemd-remount-fs.html", + "systemd-repart(8)": "https://www.freedesktop.org/software/systemd/man/systemd-repart.html", + "systemd-repart.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-repart.service.html", + "systemd-resolved(8)": "https://www.freedesktop.org/software/systemd/man/systemd-resolved.html", + "systemd-rfkill(8)": "https://www.freedesktop.org/software/systemd/man/systemd-rfkill.html", + "systemd-rfkill.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-rfkill.socket.html", + "systemd-run-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-run-generator.html", + "systemd-shutdown(8)": "https://www.freedesktop.org/software/systemd/man/systemd-shutdown.html", + "systemd-sleep(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sleep.html", + "systemd-socket-proxyd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-socket-proxyd.html", + "systemd-soft-reboot.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-soft-reboot.service.html", + "systemd-suspend-then-hibernate.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-suspend-then-hibernate.service.html", + "systemd-suspend.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-suspend.service.html", + "systemd-sysctl(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysctl.html", + "systemd-sysext(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysext.html", + "systemd-sysext.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysext.service.html", + "systemd-system-update-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-system-update-generator.html", + "systemd-sysupdate-reboot.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysupdate-reboot.service.html", + "systemd-sysupdate-reboot.timer(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysupdate-reboot.timer.html", + "systemd-sysupdate(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysupdate.html", + "systemd-sysupdate.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysupdate.service.html", + "systemd-sysupdate.timer(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysupdate.timer.html", + "systemd-sysusers(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysusers.html", + "systemd-sysusers.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-sysusers.service.html", + "systemd-time-wait-sync(8)": "https://www.freedesktop.org/software/systemd/man/systemd-time-wait-sync.html", + "systemd-timedated(8)": "https://www.freedesktop.org/software/systemd/man/systemd-timedated.html", + "systemd-timesyncd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-timesyncd.html", + "systemd-tmpfiles-clean.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-tmpfiles-clean.service.html", + "systemd-tmpfiles-clean.timer(8)": "https://www.freedesktop.org/software/systemd/man/systemd-tmpfiles-clean.timer.html", + "systemd-tmpfiles-setup-dev-early.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-tmpfiles-setup-dev-early.service.html", + "systemd-tmpfiles-setup-dev.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-tmpfiles-setup-dev.service.html", + "systemd-tmpfiles-setup.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-tmpfiles-setup.service.html", + "systemd-tmpfiles(8)": "https://www.freedesktop.org/software/systemd/man/systemd-tmpfiles.html", + "systemd-udev-settle.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-udev-settle.service.html", + "systemd-udevd-control.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-udevd-control.socket.html", + "systemd-udevd-kernel.socket(8)": "https://www.freedesktop.org/software/systemd/man/systemd-udevd-kernel.socket.html", + "systemd-udevd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-udevd.html", + "systemd-update-done(8)": "https://www.freedesktop.org/software/systemd/man/systemd-update-done.html", + "systemd-update-utmp-runlevel.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-update-utmp-runlevel.service.html", + "systemd-update-utmp(8)": "https://www.freedesktop.org/software/systemd/man/systemd-update-utmp.html", + "systemd-user-sessions(8)": "https://www.freedesktop.org/software/systemd/man/systemd-user-sessions.html", + "systemd-userdbd(8)": "https://www.freedesktop.org/software/systemd/man/systemd-userdbd.html", + "systemd-vconsole-setup(8)": "https://www.freedesktop.org/software/systemd/man/systemd-vconsole-setup.html", + "systemd-veritysetup-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-veritysetup-generator.html", + "systemd-veritysetup(8)": "https://www.freedesktop.org/software/systemd/man/systemd-veritysetup.html", + "systemd-veritysetup@.service(8)": "https://www.freedesktop.org/software/systemd/man/systemd-veritysetup@.service.html", + "systemd-volatile-root(8)": "https://www.freedesktop.org/software/systemd/man/systemd-volatile-root.html", + "systemd-xdg-autostart-generator(8)": "https://www.freedesktop.org/software/systemd/man/systemd-xdg-autostart-generator.html", + "udevadm(8)": "https://www.freedesktop.org/software/systemd/man/udevadm.html" } diff --git a/nixpkgs/doc/manual.md.in b/nixpkgs/doc/manual.md.in index 52971ff526c2..642247e16612 100644 --- a/nixpkgs/doc/manual.md.in +++ b/nixpkgs/doc/manual.md.in @@ -1,4 +1,4 @@ -# Nixpkgs Manual {#nixpkgs-manual} +# Nixpkgs Reference Manual {#nixpkgs-manual} ## Version @MANUAL_VERSION@ ```{=include=} chapters diff --git a/nixpkgs/doc/preface.chapter.md b/nixpkgs/doc/preface.chapter.md index aa6acca1217a..93cd1a00b4f2 100644 --- a/nixpkgs/doc/preface.chapter.md +++ b/nixpkgs/doc/preface.chapter.md @@ -6,11 +6,15 @@ The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the Packages are available for several platforms, and can be used with the Nix package manager on most GNU/Linux distributions as well as [NixOS](https://nixos.org/nixos). -This manual primarily describes how to write packages for the Nix Packages collection -(Nixpkgs). Thus it’s mainly for packagers and developers who want to add packages to -Nixpkgs. If you like to learn more about the Nix package manager and the Nix -expression language, then you are kindly referred to the [Nix manual](https://nixos.org/nix/manual/). -The NixOS distribution is documented in the [NixOS manual](https://nixos.org/nixos/manual/). +This document is the user [_reference_](https://nix.dev/contributing/documentation/diataxis#reference) manual for Nixpkgs. +It describes entire public interface of Nixpkgs in a concise and orderly manner, and all relevant behaviors, with examples and cross-references. + +To discover other kinds of documentation: +- [nix.dev](https://nix.dev/): Tutorials and guides for getting things done with Nix +- [NixOS **Option Search**](https://search.nixos.org/options) and reference documentation +- [Nixpkgs **Package Search**](https://search.nixos.org/packages) +- [**NixOS** manual](https://nixos.org/manual/nixos/stable/): Reference documentation for the NixOS Linux distribution +- [`CONTRIBUTING.md`](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md): Contributing to Nixpkgs, including this manual ## Overview of Nixpkgs {#overview-of-nixpkgs} |