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

Documentation: add vmTools #197247

Merged
merged 3 commits into from
Apr 13, 2023
Merged

Documentation: add vmTools #197247

merged 3 commits into from
Apr 13, 2023

Conversation

kip93
Copy link
Contributor

@kip93 kip93 commented Oct 22, 2022

Description of changes

#190809 states that there was no docs for runInLinuxVM, but when looking at the manual I found that the entire vmTools 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 and extractMTDfs, for which I can't think of any clear / concise examples.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 22.11 Release Notes (or backporting 22.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

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.

@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.

doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
doc/builders/special/vm-tools.section.md Outdated Show resolved Hide resolved
@kip93
Copy link
Contributor Author

kip93 commented Apr 9, 2023

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.

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.

Looks awesome, thanks a lot for keeping at it!

@fricklerhandwerk fricklerhandwerk merged commit 18ffde7 into NixOS:master Apr 13, 2023
@kip93 kip93 deleted the vmTools-docs branch April 13, 2023 22:31
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.

3 participants