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 file system object content addressing #10479

Merged
merged 1 commit into from
May 15, 2024

Conversation

Ericson2314
Copy link
Member

@Ericson2314 Ericson2314 commented Apr 11, 2024

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.

doc/manual/src/glossary.md Outdated Show resolved Hide resolved
doc/manual/redirects.js Outdated Show resolved Hide resolved
doc/manual/src/glossary.md Outdated Show resolved Hide resolved
doc/manual/src/glossary.md Show resolved Hide resolved
doc/manual/src/store/file-system-object/content-address.md Outdated Show resolved Hide resolved
doc/manual/src/store/file-system-object/content-address.md Outdated Show resolved Hide resolved
doc/manual/src/store/store-path.md Outdated Show resolved Hide resolved
src/libcmd/misc-store-flags.cc Outdated Show resolved Hide resolved
src/libutil/file-content-address.hh Outdated Show resolved Hide resolved
src/nix/unix/daemon.cc Outdated Show resolved Hide resolved
@Ericson2314
Copy link
Member Author

Ericson2314 commented 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 Ericson2314 force-pushed the ca-fso-docs branch 4 times, most recently from 0a6c547 to 51d3977 Compare April 15, 2024 21:02
@Ericson2314 Ericson2314 marked this pull request as ready for review April 15, 2024 21:03
@github-actions github-actions bot added the contributor-experience Developer experience for Nix contributors label Apr 19, 2024
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.

Will try to do a single large review next time instead of batches.
"Refresh" notification made me submit earlier (by choice).

doc/manual/src/store/file-system-object/content-address.md Outdated Show resolved Hide resolved
doc/manual/src/store/file-system-object/content-address.md Outdated Show resolved Hide resolved
doc/manual/src/store/file-system-object/content-address.md Outdated Show resolved Hide resolved
doc/manual/src/store/file-system-object/content-address.md Outdated Show resolved Hide resolved
doc/manual/src/store/file-system-object/content-address.md Outdated Show resolved Hide resolved
doc/manual/src/store/store-path.md Outdated Show resolved Hide resolved
doc/manual/src/store/store-path.md Outdated Show resolved Hide resolved
@@ -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
Copy link
Member

Choose a reason for hiding this comment

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

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.

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 roberth enabled auto-merge May 15, 2024 20:32
@roberth roberth merged commit 303268b into NixOS:master May 15, 2024
7 checks passed
@Ericson2314 Ericson2314 deleted the ca-fso-docs branch May 15, 2024 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor-experience Developer experience for Nix contributors documentation new-cli Relating to the "nix" command
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants