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

Improve a small piece of documentation #4143

Open
Zig-03 opened this Issue Jul 25, 2018 · 3 comments

Comments

Projects
None yet
3 participants
@Zig-03

Zig-03 commented Jul 25, 2018

This is not a major issue, but two lines of text would add a lot of clarity to this piece of documentation. In this exact paragraph I don't understand what exactly I should type, everything that comes after 0000:? including /usb3 text or not? To avoid all this, adding two examples would make everything clearer. Thank you.

https://www.qubes-os.org/doc/assigning-devices/

Approximately expected documentation:

This should output something like:

../../../devices/pci-0/pci0000:00/0000:00:1a.0/usb3

Now you see the BDF address in the path (right before final usb3). Strip the leading 0000: and pass the rest to the qvm-pci tool to attach the controller with the version specific steps above.

On R 4.0 the command would look something like
qvm-pci attach --persistent personal dom0:00:1a.0/usb3

On R 3.2 the command would look something like
qvm-pci -a personal 00:1a.0/usb3

Actual documentation:

This should output something like:

../../../devices/pci-0/pci0000:00/0000:00:1a.0/usb3

Now you see the BDF address in the path (right before final usb3). Strip the leading 0000: and pass the rest to the qvm-pci tool to attach the controller with the version specific steps above.

p.s. I'm not sure if what comes after dom0 in this example qvm-pci attach --persistent personal dom0:00:1a.0/usb3 is correct, since I haven't figured out what exactly I should copy from here ../../../devices/pci-0/pci0000:00/0000:00:1a.0/usb3 to make the command work properly.

@t4777sd

This comment has been minimized.

Show comment
Hide comment
@t4777sd

t4777sd Jul 25, 2018

You can click "Edit this page" on the doc page to change the documentation. After editing it you have to send a pull request as it forks the docs.

t4777sd commented Jul 25, 2018

You can click "Edit this page" on the doc page to change the documentation. After editing it you have to send a pull request as it forks the docs.

@Zig-03

This comment has been minimized.

Show comment
Hide comment
@Zig-03

Zig-03 Jul 25, 2018

@t4777sd thanks, never done that. I'll try.

Zig-03 commented Jul 25, 2018

@t4777sd thanks, never done that. I'll try.

@andrewdavidwong andrewdavidwong added this to the Ongoing milestone Jul 26, 2018

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Jul 26, 2018

Member

More information about contributing to the documentation:

https://www.qubes-os.org/doc/doc-guidelines/

Member

andrewdavidwong commented Jul 26, 2018

More information about contributing to the documentation:

https://www.qubes-os.org/doc/doc-guidelines/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment