mirror of
https://github.com/cloud-hypervisor/cloud-hypervisor.git
synced 2024-08-22 07:51:16 +00:00
virtio-devices: fix accidental HTML in doc comments
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:
parent
f6236087d8
commit
a807b91f86
@ -87,7 +87,7 @@ enum EpollListener {
|
|||||||
},
|
},
|
||||||
/// A listener interested in new host-initiated connections.
|
/// A listener interested in new host-initiated connections.
|
||||||
HostSock,
|
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.
|
/// connected host socket.
|
||||||
LocalStream(UnixStream),
|
LocalStream(UnixStream),
|
||||||
}
|
}
|
||||||
@ -113,7 +113,7 @@ pub struct VsockMuxer {
|
|||||||
/// The Unix socket, through which host-initiated connections are accepted.
|
/// The Unix socket, through which host-initiated connections are accepted.
|
||||||
host_sock: UnixListener,
|
host_sock: UnixListener,
|
||||||
/// The file system path of the host-side Unix socket. This is used to figure out the path
|
/// 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,
|
host_sock_path: String,
|
||||||
/// The nested epoll File, used to register epoll listeners.
|
/// The nested epoll File, used to register epoll listeners.
|
||||||
epoll_file: File,
|
epoll_file: File,
|
||||||
|
Loading…
Reference in New Issue
Block a user