Skip to content

Commit 3a43e1f

Browse files
committed
riscv-semihosting: fix ambiguous documentation link
Fix the following warning when generating the crate documentation: warning: `syscall` is both a function and a macro --> riscv-semihosting/src/lib.rs:212:15 | 212 | /// Same as [`syscall`]. | ^^^^^^^ ambiguous link | = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default help: to link to the function, add parentheses | 212 | /// Same as [`syscall()`]. | ++ help: to link to the macro, add an exclamation mark | 212 | /// Same as [`syscall!`]. | +
1 parent 5612138 commit 3a43e1f

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

riscv-semihosting/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
99

1010
- Made `cfg` variable selection more robust for custom targets
1111
- Fixed debug::exit() on riscv64 QEMU simulation
12+
- Fixed an ambiguous link in the generated crate documentation.
1213

1314
## [v0.1.0] - 2023-01-18
1415

riscv-semihosting/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ pub unsafe fn syscall<T>(nr: usize, arg: &T) -> usize {
209209
///
210210
/// # Safety
211211
///
212-
/// Same as [`syscall`].
212+
/// Same as [`syscall()`].
213213
#[inline(always)]
214214
pub unsafe fn syscall1(_nr: usize, _arg: usize) -> usize {
215215
match () {

0 commit comments

Comments
 (0)