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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

reword documentation on nix-copy-closure #10709

Merged

Conversation

fricklerhandwerk
Copy link
Contributor

Motivation

Based on discussion with @eflanagan0 and @wamirez.

Related: #10708

Context

  • one sentence per line
  • be more precise with respect to which Nix stores are being accessed
  • make a clear distinction between store paths and store objects
  • add links to definitions of terms

Priorities and Process

Add 馃憤 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

- one sentence per line
- be more precise with respect to which Nix stores are being accessed
- make a clear distinction between store paths and store objects
- add links to definitions of terms
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.

Still doing the counterfactual swing, and have a small suggestion. Otherwise looks good.

doc/manual/src/command-ref/nix-copy-closure.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-copy-closure.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-copy-closure.md Outdated Show resolved Hide resolved
doc/manual/src/command-ref/nix-copy-closure.md Outdated Show resolved Hide resolved
fricklerhandwerk and others added 2 commits May 20, 2024 17:51
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
@fricklerhandwerk
Copy link
Contributor Author

@roberth thanks for the review, the whole "which machine is which" business really needed clarification. Last round now?

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.

Wish it was the final round, but we're closing in.

doc/manual/src/command-ref/nix-copy-closure.md Outdated Show resolved Hide resolved
@fricklerhandwerk
Copy link
Contributor Author

Ah good, you helped me discover a major error documentation.

@eflanagan0
Copy link
Contributor

End-user, nix novice here. A naive read of the current versions flows quite well for me. I appreciate the changes to clarify how to use this tool!

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.

I think the store option should be integrated, but this PR is already an improvement.

[`--gzip`]
[`--include-outputs`]
[`--use-substitutes` | `-s`]
[`-v`]
_user@machine_ _paths_
[_user_@]_machine_[:_port_] _paths_
Copy link
Member

Choose a reason for hiding this comment

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

Fwiw, SSH would call this a "destination" and that would be absolutely awful for us to use.

@fricklerhandwerk fricklerhandwerk merged commit 77cb02b into NixOS:master May 21, 2024
9 checks passed
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.

None yet

3 participants