Merge branch 'fix-rustdoc-warnings' into 'master'

Fix most rustdoc warnings

See merge request redox-os/relibc!1151
This commit is contained in:
Jeremy Soller
2026-04-01 18:47:12 -06:00
8 changed files with 10 additions and 10 deletions
+1 -1
View File
@@ -48,7 +48,7 @@ pub struct Dl_info_t {
dli_saddr: *mut c_void,
}
/// alias as per spec update: https://www.austingroupbugs.net/view.php?id=1847
/// alias as per spec update: <https://www.austingroupbugs.net/view.php?id=1847>
pub type Dl_info = Dl_info_t;
/// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/dladdr.html>.
+1 -1
View File
@@ -8,7 +8,7 @@
//! and `musl`.
//!
//! The functions come in sets of three. Each of them print the program binary name (the last path
//! segment of arg[0]) and an optional user message along with these differences:
//! segment of `argv[0]`) and an optional user message along with these differences:
//! * No suffix: Prints an error message for ERRNO based on [`strerror`]
//! * `c` suffix: Prints an error message for an arbitrary error code
//! * `x` suffix: Does not print an error code
+2 -2
View File
@@ -1,4 +1,4 @@
// https://pubs.opengroup.org/onlinepubs/9699919799/functions/getline.html
// See <https://pubs.opengroup.org/onlinepubs/9799919799/functions/getline.html>.
use alloc::vec::Vec;
use core::{intrinsics::unlikely, ptr};
@@ -31,7 +31,7 @@ pub unsafe extern "C" fn getline(
// One *could* read the standard as 'getdelim sets the stream error flag on *any* error, though
// since glibc doesn't seem to do this, I won't either
/// https://pubs.opengroup.org/onlinepubs/9699919799/functions/getline.html
/// <https://pubs.opengroup.org/onlinepubs/9799919799/functions/getline.html>
///
/// # Safety
/// - `lineptr, *lineptr, `n`, `stream` pointers must be valid and have to be aligned.
+1 -1
View File
@@ -1,4 +1,4 @@
//! Helper functions for pseudorandom number generation using LCG, see https://pubs.opengroup.org/onlinepubs/9699919799.2018edition/functions/drand48.html
//! Helper functions for pseudorandom number generation using LCG, see <https://pubs.opengroup.org/onlinepubs/9799919799/functions/drand48.html>.
use crate::{
platform::types::{c_double, c_long, c_ushort},
+1 -1
View File
@@ -1,4 +1,4 @@
//! Helper functions for random() and friends, see https://pubs.opengroup.org/onlinepubs/7908799/xsh/initstate.html
//! Helper functions for random() and friends, see <https://pubs.opengroup.org/onlinepubs/9799919799/functions/initstate.html>.
// Ported from musl's implementation (src/prng/random.c)
use crate::{
+1 -1
View File
@@ -3,7 +3,7 @@
//! See <https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/sys_time.h.html>.
//!
//! Note that since the Open Group Base Specifications Issue 8, the
//! [`timeval`](crate::header::sys_select::timeval) struct has been moved to
//! [`timeval`] struct has been moved to
//! the [`sys/select.h`](crate::header::sys_select) header.
use crate::{
+2 -2
View File
@@ -206,9 +206,9 @@ impl<R: Seek> Seek for BufReader<R> {
/// `.into_inner()` immediately after a seek yields the underlying reader
/// at the same position.
///
/// To seek without discarding the internal buffer, use [`Seek::seek_relative`].
/// To seek without discarding the internal buffer, use [`seek_relative`](crate::io::BufReader::seek_relative).
///
/// See [`std::io::Seek`] for more details.
/// See [`std::io::Seek`](https://doc.rust-lang.org/std/io/trait.Seek.html) for more details.
///
/// Note: In the edge case where you're seeking with `SeekFrom::Current(n)`
/// where `n` minus the internal buffer length overflows an `i64`, two
+1 -1
View File
@@ -50,7 +50,7 @@ pub struct Tcb {
pub generic: GenericTcb<OsSpecific>,
/// Pointer to a list of initial TLS data
pub masters_ptr: *mut Master,
/// Size of the masters list in bytes (multiple of mem::size_of::<Master>())
/// Size of the masters list in bytes (multiple of `mem::size_of::<Master>()`)
pub masters_len: usize,
/// Index of last copied Master
pub num_copied_masters: usize,