Skip to content

Commit c513fae

Browse files
committed
Fixes doc links
1 parent f572d49 commit c513fae

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

.github/workflows/ci.yml

+4
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ jobs:
3838
shell: cp -v {0} zfi.toml
3939
- name: Run tests
4040
run: cargo test
41+
- name: Build docs
42+
run: cargo doc --workspace --no-deps
43+
env:
44+
RUSTDOCFLAGS: -D warnings

src/boot.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ impl BootServices {
7979
}
8080

8181
/// # Safety
82-
/// `base` must be allocated with [`allocate_pages()`].
82+
/// `base` must be allocated with [`Self::allocate_pages()`].
8383
pub unsafe fn free_pages(&self, base: *mut u8, pages: usize) -> Result<(), Status> {
8484
let status = (self.free_pages)(base as _, pages);
8585

@@ -91,8 +91,8 @@ impl BootServices {
9191
}
9292

9393
/// Returns the current memory map. A common mistake when using this method to get a key to
94-
/// invoke [`exit_boot_services()`] is discarding the result, which will cause the vector to
95-
/// drop and memory map will be changed.
94+
/// invoke [`Self::exit_boot_services()`] is discarding the result, which will cause the vector
95+
/// to drop and memory map will be changed.
9696
pub fn get_memory_map(&self) -> Result<(Vec<MemoryDescriptor>, usize), Status> {
9797
let mut len = 1;
9898

@@ -142,7 +142,7 @@ impl BootServices {
142142
}
143143

144144
/// # Safety
145-
/// `mem` must be allocated by [`allocate_pool()`].
145+
/// `mem` must be allocated by [`Self::allocate_pool()`].
146146
pub unsafe fn free_pool(&self, mem: *mut u8) -> Result<(), Status> {
147147
(self.free_pool)(mem).err_or(())
148148
}

testing/src/qemu/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ pub fn gen_qemu_test(proj: PathBuf, mut root: PathBuf, name: &str, body: &str) -
132132
root
133133
}
134134

135-
/// Run the project that was generated by [`qemu`] attribute.
135+
/// Run the project that was generated by [`gen_qemu_test()`].
136136
pub fn run_qemu_test<P: AsRef<Path>>(root: P) {
137137
let root = root.as_ref();
138138

0 commit comments

Comments
 (0)