External/cloud-hypervisor
1
0
Fork 0
mirror of https://github.com/cloud-hypervisor/cloud-hypervisor.git synced 2024-12-22 05:35:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

virtio-devices: fix accidental HTML in doc comments

Browse Source 
Doc comments are Markdown, and can include HTML tags.  Anything in
angle brackets will therefore be inserted as an HTML tag into
rustdoc's output.  If that's not intentional, the left angle bracket
needs to be escaped.

I haven't fixed the doc comments in src/main.rs, because argh doesn't
understand the escaping, so the backslashes would show up in the
--help output.  I've opened https://github.com/google/argh/issues/159
about that.

Signed-off-by: Alyssa Ross <hi@alyssa.is>
This commit is contained in:
Alyssa Ross 2023-04-04 16:26:22 +00:00 committed by Bo Chen
parent f6236087d8
commit a807b91f86
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
virtio-devices/src/vsock/unix/muxer.rs
View File

@ -87,7 +87,7 @@ enum EpollListener {
},
/// A listener interested in new host-initiated connections.
HostSock,
/// A listener interested in reading host "connect <port>" commands from a freshly
/// A listener interested in reading host "connect \<port>" commands from a freshly
/// connected host socket.
LocalStream(UnixStream),
}
@ -113,7 +113,7 @@ pub struct VsockMuxer {
/// The Unix socket, through which host-initiated connections are accepted.
host_sock: UnixListener,
/// The file system path of the host-side Unix socket. This is used to figure out the path
/// to Unix sockets listening on specific ports. I.e. "<this path>_<port number>".
/// to Unix sockets listening on specific ports. I.e. "\<this path>_\<port number>".
host_sock_path: String,
/// The nested epoll File, used to register epoll listeners.
epoll_file: File,