From a807b91f8647e08037de7132ae6656828bf9977b Mon Sep 17 00:00:00 2001 From: Alyssa Ross Date: Tue, 4 Apr 2023 16:26:22 +0000 Subject: [PATCH] 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 --- virtio-devices/src/vsock/unix/muxer.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/virtio-devices/src/vsock/unix/muxer.rs b/virtio-devices/src/vsock/unix/muxer.rs index f7ac97854..2972d3a68 100644 --- a/virtio-devices/src/vsock/unix/muxer.rs +++ b/virtio-devices/src/vsock/unix/muxer.rs @@ -87,7 +87,7 @@ enum EpollListener { }, /// A listener interested in new host-initiated connections. HostSock, - /// A listener interested in reading host "connect " commands from a freshly + /// A listener interested in reading host "connect \" 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. "_". + /// to Unix sockets listening on specific ports. I.e. "\_\". host_sock_path: String, /// The nested epoll File, used to register epoll listeners. epoll_file: File,