moraxyc/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

Update docs

Browse source
This commit is contained in:
Eelco Dolstra 2022-02-22 14:32:56 +01:00
parent 38eea2c503
commit 1a6548ca75
9 changed files with 29 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/nix/bundle.md
View file

@ -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 If no flake output attribute is given, `nix bundle` tries the following
flake output attributes: flake output attributes:
* `defaultBundler.<system>` * `bundlers.<system>.default`
If an attribute *name* is given, `nix run` tries the following flake If an attribute *name* is given, `nix run` tries the following flake
output attributes: output attributes:
* `bundler.<system>.<name>` * `bundlers.<system>.<name>`
# Bundlers # Bundlers
A bundler is specified by a flake output attribute named A bundler is specified by a flake output attribute named
`bundlers.<system>.<name>` or `defaultBundler.<system>`. It looks like this: `bundlers.<system>.<name>`. It looks like this:
```nix ```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 A bundler must be a function that accepts an arbitrary value (typically a

4
src/nix/develop.md
View file

@ -88,9 +88,9 @@ the flake's `nixConfig` attribute.
If no flake output attribute is given, `nix develop` tries the following If no flake output attribute is given, `nix develop` tries the following
flake output attributes: flake output attributes:
* `devShell.<system>` * `devShells.<system>.default`
* `defaultPackage.<system>` * `packages.<system>.default`
If a flake output *name* is given, `nix develop` tries the following flake If a flake output *name* is given, `nix develop` tries the following flake
output attributes: output attributes:

8
src/nix/flake-init.md
View file

@ -24,13 +24,13 @@ R""(
This command creates a flake in the current directory by copying the This command creates a flake in the current directory by copying the
files of a template. It will not overwrite existing files. The default 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`. using `-t`.
# Template definitions # Template definitions
A flake can declare templates through its `templates` and A flake can declare templates through its `templates` output
`defaultTemplate` output attributes. A template has two attributes: attribute. A template has two attributes:
* `description`: A one-line description of the template, in CommonMark * `description`: A one-line description of the template, in CommonMark
syntax. syntax.
@ -61,7 +61,7 @@ outputs = { self }: {
''; '';
}; };
templates.defaultTemplate = self.templates.rust; templates.default = self.templates.rust;
} }
``` ```

11
src/nix/flake-show.md
View file

@ -13,10 +13,13 @@ R""(
│ │ └───build: derivation 'patchelf-0.12.20201207.f34751b' │ │ └───build: derivation 'patchelf-0.12.20201207.f34751b'
│ └───x86_64-linux │ └───x86_64-linux
│ └───build: derivation 'patchelf-0.12.20201207.f34751b' │ └───build: derivation 'patchelf-0.12.20201207.f34751b'
├───defaultPackage ├───packages
│ ├───aarch64-linux: package 'patchelf-0.12.20201207.f34751b' │ ├───aarch64-linux
│ ├───i686-linux: package 'patchelf-0.12.20201207.f34751b' │ │ └───default: package 'patchelf-0.12.20201207.f34751b'
│ └───x86_64-linux: 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 ├───hydraJobs
│ ├───build │ ├───build
│ │ ├───aarch64-linux: derivation 'patchelf-0.12.20201207.f34751b' │ │ ├───aarch64-linux: derivation 'patchelf-0.12.20201207.f34751b'

2
src/nix/flake.md
View file

@ -236,7 +236,7 @@ derivation):
outputs = { self, nixpkgs }: { outputs = { self, nixpkgs }: {
defaultPackage.x86_64-linux = packages.x86_64-linux.default =
# Notice the reference to nixpkgs here. # Notice the reference to nixpkgs here.
with import nixpkgs { system = "x86_64-linux"; }; with import nixpkgs { system = "x86_64-linux"; };
stdenv.mkDerivation { stdenv.mkDerivation {

6
src/nix/nix.md
View file

@ -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 For example, if `/foo/bar/flake.nix` exists, then `/foo/bar/baz/` will resolve to
`path:/foo/bar` `path:/foo/bar`
If *attrpath* is omitted, Nix tries some default values; for most If *attrpath* is omitted, Nix tries some default values; for most
subcommands, the default is `defaultPackage.`*system* subcommands, the default is `packages.`*system*`.default`
(e.g. `defaultPackage.x86_64-linux`), but some subcommands have (e.g. `packages.x86_64-linux.default`), but some subcommands have
other defaults. If *attrpath* *is* specified, *attrpath* is other defaults. If *attrpath* *is* specified, *attrpath* is
interpreted as relative to one or more prefixes; for most interpreted as relative to one or more prefixes; for most
subcommands, these are `packages.`*system*, subcommands, these are `packages.`*system*,

2
src/nix/profile-list.md
View file

@ -8,7 +8,7 @@ R""(
# nix profile list # 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 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 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 # Description

2
src/nix/profile.md
View file

@ -96,7 +96,7 @@ has the following fields:
user specified, but the one resulting from applying the default user specified, but the one resulting from applying the default
attribute paths and prefixes; for instance, `hello` might resolve to attribute paths and prefixes; for instance, `hello` might resolve to
`packages.x86_64-linux.hello` and the empty string 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. * `storePath`: The paths in the Nix store containing the package.

6
src/nix/run.md
View file

@ -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 If no flake output attribute is given, `nix run` tries the following
flake output attributes: flake output attributes:
* `defaultApp.<system>` * `apps.<system>.default`
* `defaultPackage.<system>` * `packages.<system>.default`
If an attribute *name* is given, `nix run` tries the following flake If an attribute *name* is given, `nix run` tries the following flake
output attributes: output attributes:
@ -74,7 +74,7 @@ output attributes:
# Apps # Apps
An app is specified by a flake output attribute named An app is specified by a flake output attribute named
`apps.<system>.<name>` or `defaultApp.<system>`. It looks like this: `apps.<system>.<name>`. It looks like this:
```nix ```nix
apps.x86_64-linux.blender_2_79 = { apps.x86_64-linux.blender_2_79 = {