docs: add more depth to Flake input #2812
Open
+8
−1
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
toastal
force-pushed
the
nix-docs-flake-follows-input
branch
from
69f08a7 to
f889a12
Compare
|
Thank you for this @toastal. This repository has 31 different variants, so we have 31 separate Changes to |
At present, if a user copy-pastes the current documentation, a version of Nixpkgs will be added to their ``flake.lock`` lockfile. This is probably not what the user wants as Nixpkgs, the tarball, is quite large & the user likely expects the StevenBlack Flake to be used as a module to just be using the Nixpkgs of the system. This change should also help new Nix users know how to pin a Nix version if there ever comes a time where the Nix :ac:`API` changes—even if ``lib`` tries to be stable & backwards-compatible. Additionally, provide a comment about where & what the input can be—such as a mirror or a local fork for development. Format: text/x-rst
toastal
force-pushed
the
nix-docs-flake-follows-input
branch
from
f889a12 to
72a93d1
Compare
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.
At present, if a user copy-pastes the current documentation, a version of Nixpkgs will be added to their
flake.locklockfile. This is probably not what the user wants as Nixpkgs, the tarball, is quite large & the user likely expects the StevenBlack Flake to be used as a module to just be using the Nixpkgs of the system.This change should also help new Nix users know how to pin a Nix version if there ever comes a time where the Nix API changes—even if
libtries to be stable & backwards-compatible.Additionally, provide a comment about where & what the input can be—such as a mirror or a local fork for development.
Also has been open @ https://gitlab.com/StevenBlack/hosts/-/merge_requests/1