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.

Sign up for GitHub

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

Jump to bottom

Fix typos and broken link in README.md #509

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typos and broken link in README.md #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The binaries built by this repository can be run with any VMM which
can act as a vhost-user frontend. Typically they have been tested with
[QEMU](https://www.qemu.org) although the rust-vmm project does
provide a [vhost-user
frontend](https://github.com/rust-vmm/vhost/tree/main/src/vhost_user)
frontend](https://github.com/rust-vmm/vhost/blob/main/crates/vhost/src/vhost_user/frontend.rs)
Copy link
Member

Choose a reason for hiding this comment

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

I think it'd be much better if it linked to the directory that also displays the README.md instead of the source code file: https://github.com/rust-vmm/vhost/tree/main/crates/vhost

crate for rust based VMMs.

While it's possible to implement all parts of the backend inside the
Expand Down
2 changes: 1 addition & 1 deletion vhost-device-i2c/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Examples section below.
Example: --device-list "i915 gmbus dpd:32:21,DPDDC-D:10:23"

Here,
bus-name: is adatper's name. e.g. value of /sys/bus/i2c/devices/i2c-0/name.
bus-name: is adapter's name. e.g. value of /sys/bus/i2c/devices/i2c-0/name.
client_addr (decimal): address for client device, 32 == 0x20.

## Examples
Expand Down
4 changes: 2 additions & 2 deletions vhost-device-rng/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ requests more bytes than the allowed limit the thread will block until the
start of a new period. The daemon will automatically split the available
bandwidth equally between the guest when several threads are requested.

Thought developed and tested with QEMU, the implemenation is based on the
Thought developed and tested with QEMU, the implementation is based on the
vhost-user protocol and as such should be interoperable with other virtual
machine managers. Please see below for working examples.

Expand Down Expand Up @@ -48,7 +48,7 @@ machine managers. Please see below for working examples.

.. option:: -m, --max-bytes

In conjuction with the --period parameter, provides the maximum number of byte
In conjunction with the --period parameter, provides the maximum number of byte
per milliseconds a RNG device can generate.

## Examples
Expand Down