-
-
Notifications
You must be signed in to change notification settings - Fork 14.1k
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
Documentation: add vmTools #197247
Documentation: add vmTools #197247
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kip93 thanks for this great contribution, really well done. Sorry that you had to wait so much, I only now got to work off my backlog.
I left a few change requests concerning formatting, but in terms of content and wording this is exemplary. I like it a lot. We need more of that kind.
The structure of the attribute listings strikes me as a bit unusual, but we haven't converged on a consistent style across the manual anyway, so it's not really important.
Sorry for taking so long, this PR slipped my mind for the longest time. I've rebased and updated to keep up to date with the changes in the source code, plus applied the suggested changes. The only standing issue is with the examples. Don't know how to improve them to make them more friendly to a new user, these seem to me clear for the topic at hand, and cover the more common scenarios that I can think of. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks awesome, thanks a lot for keeping at it!
Description of changes
#190809 states that there was no docs for
runInLinuxVM
, but when looking at the manual I found that the entirevmTools
set is missing. I tried extracting the comments from that file into the docs, do some reformatting, and finally test and add some examples of my own.Only thing missing are
extractFs
andextractMTDfs
, for which I can't think of any clear / concise examples.Things done
sandbox = true
set innix.conf
? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"
. Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/
)nixos/doc/manual/md-to-db.sh
to update generated release notes