From 1a6548ca757f81594f5b54d8dada4c5ba65821de Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Tue, 22 Feb 2022 14:32:56 +0100 Subject: [PATCH] Update docs --- src/nix/bundle.md | 14 ++++++++------ src/nix/develop.md | 4 ++-- src/nix/flake-init.md | 8 ++++---- src/nix/flake-show.md | 11 +++++++---- src/nix/flake.md | 2 +- src/nix/nix.md | 6 ++---- src/nix/profile-list.md | 2 +- src/nix/profile.md | 2 +- src/nix/run.md | 6 +++--- 9 files changed, 29 insertions(+), 26 deletions(-) diff --git a/src/nix/bundle.md b/src/nix/bundle.md index a5186a996..2bb70711f 100644 --- a/src/nix/bundle.md +++ b/src/nix/bundle.md @@ -42,24 +42,26 @@ homepage](https://github.com/NixOS/bundlers) for more details. If no flake output attribute is given, `nix bundle` tries the following flake output attributes: -* `defaultBundler.` +* `bundlers..default` If an attribute *name* is given, `nix run` tries the following flake output attributes: -* `bundler..` +* `bundlers..` # Bundlers A bundler is specified by a flake output attribute named -`bundlers..` or `defaultBundler.`. It looks like this: +`bundlers..`. It looks like this: ```nix -bundlers.x86_64-linux.identity = drv: drv; +bundlers.x86_64-linux = rec { + identity = drv: drv; -bundlers.x86_64-linux.blender_2_79 = drv: self.packages.x86_64-linux.blender_2_79; + blender_2_79 = drv: self.packages.x86_64-linux.blender_2_79; -defaultBundler.x86_64-linux = drv: drv; + default = identity; +}; ``` A bundler must be a function that accepts an arbitrary value (typically a diff --git a/src/nix/develop.md b/src/nix/develop.md index 3e7e339d5..8bcff66c9 100644 --- a/src/nix/develop.md +++ b/src/nix/develop.md @@ -88,9 +88,9 @@ the flake's `nixConfig` attribute. If no flake output attribute is given, `nix develop` tries the following flake output attributes: -* `devShell.` +* `devShells..default` -* `defaultPackage.` +* `packages..default` If a flake output *name* is given, `nix develop` tries the following flake output attributes: diff --git a/src/nix/flake-init.md b/src/nix/flake-init.md index c13b22248..fc1f4f805 100644 --- a/src/nix/flake-init.md +++ b/src/nix/flake-init.md @@ -24,13 +24,13 @@ R""( This command creates a flake in the current directory by copying the files of a template. It will not overwrite existing files. The default -template is `templates#defaultTemplate`, but this can be overridden +template is `templates#templates.default`, but this can be overridden using `-t`. # Template definitions -A flake can declare templates through its `templates` and -`defaultTemplate` output attributes. A template has two attributes: +A flake can declare templates through its `templates` output +attribute. A template has two attributes: * `description`: A one-line description of the template, in CommonMark syntax. @@ -61,7 +61,7 @@ outputs = { self }: { ''; }; - templates.defaultTemplate = self.templates.rust; + templates.default = self.templates.rust; } ``` diff --git a/src/nix/flake-show.md b/src/nix/flake-show.md index e484cf47e..f3b74285d 100644 --- a/src/nix/flake-show.md +++ b/src/nix/flake-show.md @@ -13,10 +13,13 @@ R""( │ │ └───build: derivation 'patchelf-0.12.20201207.f34751b' │ └───x86_64-linux │ └───build: derivation 'patchelf-0.12.20201207.f34751b' - ├───defaultPackage - │ ├───aarch64-linux: package 'patchelf-0.12.20201207.f34751b' - │ ├───i686-linux: package 'patchelf-0.12.20201207.f34751b' - │ └───x86_64-linux: package 'patchelf-0.12.20201207.f34751b' + ├───packages + │ ├───aarch64-linux + │ │ └───default: package 'patchelf-0.12.20201207.f34751b' + │ ├───i686-linux + │ │ └───default: package 'patchelf-0.12.20201207.f34751b' + │ └───x86_64-linux + │ └───default: package 'patchelf-0.12.20201207.f34751b' ├───hydraJobs │ ├───build │ │ ├───aarch64-linux: derivation 'patchelf-0.12.20201207.f34751b' diff --git a/src/nix/flake.md b/src/nix/flake.md index accddd436..48c12d30f 100644 --- a/src/nix/flake.md +++ b/src/nix/flake.md @@ -236,7 +236,7 @@ derivation): outputs = { self, nixpkgs }: { - defaultPackage.x86_64-linux = + packages.x86_64-linux.default = # Notice the reference to nixpkgs here. with import nixpkgs { system = "x86_64-linux"; }; stdenv.mkDerivation { diff --git a/src/nix/nix.md b/src/nix/nix.md index 1dc59362d..0dacadee6 100644 --- a/src/nix/nix.md +++ b/src/nix/nix.md @@ -97,11 +97,9 @@ the Nix store. Here are the recognised types of installables: For example, if `/foo/bar/flake.nix` exists, then `/foo/bar/baz/` will resolve to `path:/foo/bar` - - If *attrpath* is omitted, Nix tries some default values; for most - subcommands, the default is `defaultPackage.`*system* - (e.g. `defaultPackage.x86_64-linux`), but some subcommands have + subcommands, the default is `packages.`*system*`.default` + (e.g. `packages.x86_64-linux.default`), but some subcommands have other defaults. If *attrpath* *is* specified, *attrpath* is interpreted as relative to one or more prefixes; for most subcommands, these are `packages.`*system*, diff --git a/src/nix/profile-list.md b/src/nix/profile-list.md index 5c29c0b02..bdab9a208 100644 --- a/src/nix/profile-list.md +++ b/src/nix/profile-list.md @@ -8,7 +8,7 @@ R""( # nix profile list 0 flake:nixpkgs#legacyPackages.x86_64-linux.spotify github:NixOS/nixpkgs/c23db78bbd474c4d0c5c3c551877523b4a50db06#legacyPackages.x86_64-linux.spotify /nix/store/akpdsid105phbbvknjsdh7hl4v3fhjkr-spotify-1.1.46.916.g416cacf1 1 flake:nixpkgs#legacyPackages.x86_64-linux.zoom-us github:NixOS/nixpkgs/c23db78bbd474c4d0c5c3c551877523b4a50db06#legacyPackages.x86_64-linux.zoom-us /nix/store/89pmjmbih5qpi7accgacd17ybpgp4xfm-zoom-us-5.4.53350.1027 - 2 flake:blender-bin#defaultPackage.x86_64-linux github:edolstra/nix-warez/d09d7eea893dcb162e89bc67f6dc1ced14abfc27?dir=blender#defaultPackage.x86_64-linux /nix/store/zfgralhqjnam662kqsgq6isjw8lhrflz-blender-bin-2.91.0 + 2 flake:blender-bin#packages.x86_64-linux.default github:edolstra/nix-warez/d09d7eea893dcb162e89bc67f6dc1ced14abfc27?dir=blender#packages.x86_64-linux.default /nix/store/zfgralhqjnam662kqsgq6isjw8lhrflz-blender-bin-2.91.0 ``` # Description diff --git a/src/nix/profile.md b/src/nix/profile.md index d3ddcd3d1..0a4ff2fa9 100644 --- a/src/nix/profile.md +++ b/src/nix/profile.md @@ -96,7 +96,7 @@ has the following fields: user specified, but the one resulting from applying the default attribute paths and prefixes; for instance, `hello` might resolve to `packages.x86_64-linux.hello` and the empty string to - `defaultPackage.x86_64-linux`. + `packages.x86_64-linux.default`. * `storePath`: The paths in the Nix store containing the package. diff --git a/src/nix/run.md b/src/nix/run.md index cd3b978c0..a0f362076 100644 --- a/src/nix/run.md +++ b/src/nix/run.md @@ -58,9 +58,9 @@ For instance, if `name` is set to `hello-1.10`, `nix run` will run If no flake output attribute is given, `nix run` tries the following flake output attributes: -* `defaultApp.` +* `apps..default` -* `defaultPackage.` +* `packages..default` If an attribute *name* is given, `nix run` tries the following flake output attributes: @@ -74,7 +74,7 @@ output attributes: # Apps An app is specified by a flake output attribute named -`apps..` or `defaultApp.`. It looks like this: +`apps..`. It looks like this: ```nix apps.x86_64-linux.blender_2_79 = {