Document file system object content addressing #10479
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ericson2314
force-pushed
the
ca-fso-docs
branch
from
4706b5e
to
d5b583d
Compare
roberth
requested changes
Apr 14, 2024
|
Oh woops --- I will still heavily rewriting "nix archive" and below in the new page. (The current material therein is recycled from #6877 and, in some cases, transitively, Eelco's thesis.) I'll still incorporate these suggestions in the next draft, however! |
Ericson2314
force-pushed
the
ca-fso-docs
branch
4 times, most recently
from
0a6c547
to
51d3977
Compare
Ericson2314
force-pushed
the
ca-fso-docs
branch
from
51d3977
to
93a0742
Compare
xokdvium
reviewed
Apr 19, 2024
Ericson2314
force-pushed
the
ca-fso-docs
branch
from
93a0742
to
05c90bb
Compare
github-actions
bot
added
the
contributor-experience
roberth
reviewed
Apr 24, 2024
roberth
reviewed
Apr 24, 2024
roberth
reviewed
Apr 24, 2024
roberth
reviewed
Apr 24, 2024
| @@ -10,16 +10,28 @@ namespace nix { | |||
| /** | |||
| * An enumeration of the ways we can serialize file system | |||
| * objects. | |||
| * | |||
| * See `file-system-object/content-address.md#serial` in the manual for | |||
There was a problem hiding this comment.
thought:
I've linked to the unstable manual URL before in the external API docs, but we might want to weigh that differently for internal docs.
Ericson2314
commented
May 15, 2024
In addition: - Take the opportunity to add a bunch more missing hyperlinks, too. - Remove some glossary entries that are now subsumed by dedicated pages. We used to not be able to do this without breaking link fragments, but now we can, so pick up where we left off. Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
roberth
approved these changes
May 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Trying to document the store model from the ground up. This is the next step. More things to be taken from #6877 come after.
Context
The git hashing work (#8919) has resulted in this code getting cleaned up and there being more than two cases (so bools don't suffice).
Now is a good time to shore up the docs accordingly.
Also prepares for #10480
Priorities and Process
Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.