Skip to content
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.

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

reword description of how realisation works #7592

Merged
merged 13 commits into from Sep 5, 2023

Conversation

fricklerhandwerk
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk commented Jan 12, 2023

this is to make it more readable, more concise and more correct.

This work is sponsored by Antithesis

Copy link
Member

@roberth roberth left a comment

Choose a reason for hiding this comment

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

This is getting a bit messy. Realisation is defined differently depending on the type of object, but we need all in order to explain nix-store --realise.

  • Realise an output (.drv, outputspec)
  • Realise a derivation (.drv, outputspec = all)
  • Realise an opaque path

On top of that we have the nix-store --realise behavior that it realises the derivation only after realising the .drv as an opaque path.

doc/manual/src/command-ref/nix-store.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store.md Outdated Show resolved Hide resolved
@fricklerhandwerk
Copy link
Contributor Author

@roberth addressed the review comments, please check again.

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-06-05-documentation-team-meeting-notes-52/28937/1

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-06-22-nix-team-meeting-minutes-65/29643/1

doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
Copy link
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

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

With the last round of suggestions applied, I approve of this PR. Good improvement!

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-06-26-nix-team-meeting-minutes-66/29650/1

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/tweag-nix-dev-update-50/29793/1

doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
doc/manual/src/glossary.md Outdated Show resolved Hide resolved
Copy link
Member

@roberth roberth left a comment

Choose a reason for hiding this comment

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

Close to an approval. I think we need a better description of the build process and sandbox, so I made an issue for that. (Might overlap with the derivation page content; see issue)

Build certificates aren't a thing, so that has to go. We might make it a thing, but not in this PR.

doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-store/realise.md Outdated Show resolved Hide resolved
[Nix database]: @docroot@/glossary.md#gloss-nix-database

The resulting paths are printed on standard output.
For non-derivation arguments, the argument itself is printed.
Copy link
Member

Choose a reason for hiding this comment

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

FYI We've started calling these constant paths in the code. Let's see if that sticks first.
No action needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like that name.

doc/manual/src/glossary.md Outdated Show resolved Hide resolved
@fricklerhandwerk fricklerhandwerk dismissed roberth’s stale review September 5, 2023 09:55

addressed all comments

@fricklerhandwerk fricklerhandwerk merged commit f34484d into NixOS:master Sep 5, 2023
8 checks passed
@fricklerhandwerk fricklerhandwerk deleted the nix-store-realise branch October 9, 2023 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

5 participants