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

document store paths #9207

Merged
merged 1 commit into from
Nov 2, 2023
Merged

Conversation

fricklerhandwerk
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk commented Oct 22, 2023

Motivation

this is another step to finally implement #6420, and also serves as the documentation part of NixOS/rfcs#134

since this is a cross-cutting concern, it warrants its own section in the manual.

Context

update the glossary to point to the new page.

depends on #9232

Priorities

Add 👍 to pull requests you find important.

@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-10-23-documentation-team-meeting-notes-88/34562/1

@dpulls
Copy link

dpulls bot commented Oct 25, 2023

🎉 All dependencies have been resolved !

@fricklerhandwerk fricklerhandwerk marked this pull request as draft October 25, 2023 02:32
Nix implements references to [store objects](./index.md#store-object) as *store paths*.

Think of a store path as an [opaque], [unique identifier]:
The only way to obtain store path is by adding or building store objects.
Copy link
Member

Choose a reason for hiding this comment

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

Say something about "hard to spoof" / "hard to forge?" That is why we care that they can only be produced this way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That would need some explanation on why exactly being hard to forge matters. I think this can go into the digest section, which will now end up in a separate PR.

update the glossary to point to the new page.

since this is a cross-cutting concern, it warrants its own section in
the manual.

Co-authored-by: John Ericson <git@JohnEricson.me>
Copy link

dpulls bot commented Nov 2, 2023

🎉 All dependencies have been resolved !

@Ericson2314 Ericson2314 marked this pull request as ready for review November 2, 2023 13:46
@Ericson2314 Ericson2314 changed the base branch from master to 2.18-maintenance November 2, 2023 13:46
@Ericson2314 Ericson2314 changed the base branch from 2.18-maintenance to master November 2, 2023 13:46
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.

We're off to the races now!

@Ericson2314 Ericson2314 merged commit 7f56ed8 into NixOS:master Nov 2, 2023
10 checks passed
@fricklerhandwerk fricklerhandwerk deleted the doc-store-path branch February 6, 2024 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RFC Related to an accepted RFC
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants