Skip to content

Document <drvPath>^<outputName> syntax for installables #9362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ghost wants to merge 5 commits into from
Closed

Document <drvPath>^<outputName> syntax for installables #9362

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c52ecbb
Document <drvPath>^<outputName> syntax for installables
Nov 16, 2023
8b9c37a
Update src/nix/nix.md
Nov 17, 2023
9b4588c
Update doc/manual/src/glossary.md
Nov 17, 2023
5eda47a
Update doc/manual/src/glossary.md
Nov 17, 2023
891e753
Update doc/manual/src/glossary.md
Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions doc/manual/src/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,24 @@

[store derivation]: #gloss-store-derivation

- [store derivation output reference]{#gloss-store-derivation-output-reference}

The string resulting from concatenating three things:
Comment thread
This conversation was marked as resolved.
Outdated

- The path to a [store derivation](#gloss-store-derivation)
- The character `^`
- Either:
- one of the store derivation's [output names](#gloss-output-name) or
- the character `*`
Comment thread
This conversation was marked as resolved.
Outdated

@fricklerhandwerk fricklerhandwerk Nov 16, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A plain store derivation path refers to the first output declared for that derivation.

@ghost ghost Nov 17, 2023

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hrm, @fricklerhandwerk did you mean to delete those lines in your suggestion, or did you intend to only add the new line?

> **Examples**
>
> `/nix/store/xvni94ndxy75v1wdpshk8k0l75nwyc54-stdenv-linux.drv^*`
>
> `/nix/store/llil5bng8p7203l25mqb5lwdhlaya4d9-bash-5.2-p15.drv^man`
Comment thread
This conversation was marked as resolved.
Outdated

@Qyriad Qyriad Nov 18, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See also: The store path section of the [installables syntax](@docroot@/command-ref/new-cli/nix.html#store-path), where output references are used.

It'd be good to link or explain what this syntax is a part of and where it's used.

[store derivation output reference]: #gloss-store-derivation-output-reference

- [instantiate]{#gloss-instantiate}, instantiation

Translate a [derivation] into a [store derivation].
Expand Down Expand Up @@ -212,6 +230,11 @@

[output]: #gloss-output

- [output name]{#gloss-output-name}

A string identifier, such as `out` or `man`, given to each output of a derivation.
See [the `outputs` argument to the `derivation` function](@docroot@/language/derivations.md#attr-outputs) for details; the `outputs` argument is a list and each element of this list is an output name.

- [output path]{#gloss-output-path}

The [store path] to the [output] of a [derivation].
Expand Down
1 change: 1 addition & 0 deletions src/nix/nix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ These are command line arguments that represent something that can be realised i
The following types of installable are supported by most commands:

- [Flake output attribute](#flake-output-attribute) (experimental)
- [Store derivation output reference](../../glossary.md#gloss-store-derivation-output-reference)
Comment thread
This conversation was marked as resolved.
Outdated
- [Store path](#store-path)
Comment on lines +62 to 63

@Ericson2314 Ericson2314 Nov 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then both these become deriving path

@Ericson2314 Ericson2314 Nov 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And down below the "Store path" description becomes "Deriving Path"

@Ericson2314 Ericson2314 Nov 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also see the "Derivation output selection" section down below.

- [Nix file](#nix-file), optionally qualified by an attribute path
- [Nix expression](#nix-expression), optionally qualified by an attribute path
Expand Down