From 7b7c638449e2cbc057f466a92b4c12caa8a0468b Mon Sep 17 00:00:00 2001
From: Jason White <jasonwhite@meta.com>
Date: Tue, 29 Nov 2022 13:53:16 -0800
Subject: [PATCH] Fix broken doc links

Summary: Fixes broken doc links so that `cargo doc` succeeds again.

Reviewed By: rrnewton

Differential Revision: D41588324

fbshipit-source-id: ed539bef5ea2a91562ec7d03a756ea4cc3f9000a
---
 README.md                            |  2 +-
 reverie-process/src/seccomp/notif.rs | 20 ++++++++++----------
 reverie/src/regs.rs                  |  8 +++++---
 3 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 1c7f8be..7d23c63 100644
--- a/README.md
+++ b/README.md
@@ -139,4 +139,4 @@ file for guidance.
 
 ## License
 
-Reverie is BSD 2-Clause licensed as found in the [LICENSE](LICENSE) file.
+Reverie is BSD 2-Clause licensed as found in the [LICENSE](./LICENSE) file.
diff --git a/reverie-process/src/seccomp/notif.rs b/reverie-process/src/seccomp/notif.rs
index f5f9ec6..c6ae01c 100644
--- a/reverie-process/src/seccomp/notif.rs
+++ b/reverie-process/src/seccomp/notif.rs
@@ -81,10 +81,9 @@ pub const SECCOMP_USER_NOTIF_FLAG_CONTINUE: u32 = 1u32 << 0;
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
 #[repr(C)]
 pub struct seccomp_notif_resp {
-    /// This is a cookie value that was obtained using the [`SeccompNotif::recv`]
-    /// operation. This cookie value allows the kernel to correctly associate
-    /// this response with the system call that triggered the user-space
-    /// notification.
+    /// This is a cookie value associated with this response. This cookie value
+    /// allows the kernel to correctly associate this response with the system
+    /// call that triggered the user-space notification.
     pub id: u64,
 
     /// This is the value that will be used for a spoofed success return for the
@@ -108,7 +107,7 @@ pub const SECCOMP_ADDFD_FLAG_SEND: u32 = 1u32 << 1;
 #[repr(C)]
 pub struct seccomp_notif_addfd {
     /// This field should be set to the notification ID (cookie value) that was
-    /// obtained via [`SeccompNotif::recv`].
+    /// obtained via [`seccomp_notif_resp`].
     pub id: u64,
 
     /// This field is a bit mask of flags tha tmodify the behavior of the
@@ -202,13 +201,14 @@ impl SeccompNotif {
     }
 
     /// This is used to check that a notification ID returned by an earlier
-    /// [`SeccompNotif::recv`] operation is still valid (i.e., that the target still
-    /// exists and its system call is still blocked waiting for a response).
+    /// [`SeccompNotif::poll_recv`] operation is still valid (i.e., that the
+    /// target still exists and its system call is still blocked waiting for a
+    /// response).
     ///
     /// This operation is necessary to avoid race conditions that can occur when the
-    /// `pid` returned by [`SeccompNotif::recv`] operation terminates, and that
-    /// process ID is reused by another process. An example of this kind of race is
-    /// the following:
+    /// `pid` returned by [`SeccompNotif::poll_recv`] operation terminates, and
+    /// that process ID is reused by another process. An example of this kind of
+    /// race is the following:
     ///
     ///  1. A notification is generated on the listening file descriptor. The
     ///     returned `seccomp_notif` contains the TID of the target thread (in the
diff --git a/reverie/src/regs.rs b/reverie/src/regs.rs
index 4b8bf5b..2e7350f 100644
--- a/reverie/src/regs.rs
+++ b/reverie/src/regs.rs
@@ -29,15 +29,17 @@ impl RegDisplay for libc::user_regs_struct {
     }
 }
 
-/// Options how [libc:user_regs_struct] can be formatted for [std::fmt::Display] implementation
+/// Options for how [`libc::user_regs_struct`] can be formatted for the
+/// [`std::fmt::Display`] implementation.
 #[derive(Default)]
 pub struct RegDisplayOptions {
     /// whether to display registers in a single line or format on multiple lines
     pub multiline: bool,
 }
 
-/// A wrapper defers and implements [std::fmt::Display] for [libc::user_regs_struct]
-/// according to the options represented by [RegDisplayOptions]
+/// A wrapper defers and implements [`std::fmt::Display`] for
+/// [`libc::user_regs_struct`] according to the options represented by
+/// [`RegDisplayOptions`].
 pub struct Display<'a> {
     options: RegDisplayOptions,
     regs: &'a libc::user_regs_struct,