Fix typos and broken link in README.md #509
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The link to vhost_user frontend crate and typos in the documentation are fixed Signed-off-by: Sumbal Tariq <[email protected]>
sumbal008
requested review from
mathieupoirier,
stsquad,
vireshk and
stefano-garzarella
as code owners
stsquad
approved these changes
Oct 29, 2023
|
Not sure why the DCO check is failing here? |
Because author and signed-off don't match. commit d2e15c2 (temp/fix-documentation-typos-and-link) @sumbal008 Please fix your Author email id. |
epilys
requested changes
Oct 30, 2023
| @@ -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) | |||
There was a problem hiding this comment.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the PR
The link to vhost_user frontend crate is broken and gives 404 error. This PR fixes the broken link and minor typos in the documentation.
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commitmessage has max 60 characters for the summary and max 75 characters for each
description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.