Skip to content

Document fetchTree#8509

Merged
Ericson2314 merged 1 commit intoNixOS:masterfrom
wentasah:fetch-tree-doc
Sep 28, 2023
Merged

Document fetchTree#8509
Ericson2314 merged 1 commit intoNixOS:masterfrom
wentasah:fetch-tree-doc

Conversation

@wentasah
Copy link
Contributor

Motivation

WiP commit originally included in #8491.

Context

Checklist for maintainers

Maintainers: tick if completed or explain if not relevant

  • agreed on idea
  • agreed on implementation strategy
  • tests, as appropriate
    • functional tests - tests/**.sh
    • unit tests - src/*/tests
    • integration tests - tests/nixos/*
  • documentation in the manual
  • documentation in the internal API docs
  • code and comments are self-explanatory
  • commit message explains why the change was made
  • new feature or incompatible change: updated release notes

Priorities

Add 👍 to pull requests you find important.

Copy link
Member

@thufschmitt thufschmitt left a comment

Choose a reason for hiding this comment

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

Big 👍 on the idea, though I'll defer to the doc team for reviewing the content

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

Please reformat to one sentence per line, as this will make changes in the future much less noisy.

@Ericson2314 Ericson2314 mentioned this pull request Jun 23, 2023
@fricklerhandwerk fricklerhandwerk marked this pull request as ready for review June 24, 2023 13:11
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

This looks good. Not sure if the experimental guard can be already automated. If not, ready to merge from my side.

@wentasah
Copy link
Contributor Author

I'll get to finish this tomorrow. Sorry for delays.

Co-authored-by: Valentin Gagarin <[email protected]>

Supersedes NixOS#6740
@wentasah
Copy link
Contributor Author

wentasah commented Jun 25, 2023

I made the following changes:

  • Formatted as one sentence per line.
  • Added a sentence about locked input (previous mention of flake.lock was incorrect). The question is whether it should be called locked (as in the source code) or immutable as in a recent @edolstra PR. I'd prefer immutable, in which case, we should also change this error message.
  • Changed the first example to use "locked" input.
  • Rebased to master.

@edolstra edolstra mentioned this pull request Sep 28, 2023
@edolstra edolstra modified the milestone: Flakes Sep 28, 2023
@Ericson2314 Ericson2314 merged commit b7e712f into NixOS:master Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants