Skip to content

Commit 133e350

Browse files
author
Bryant Mairs
committed
Cleanup doc warnings
With the impending switch to Pulldown as the default doc generator, warnings have been enabled for incompatible syntax. This fixes all of said warnings.
1 parent 2e8560e commit 133e350

File tree

5 files changed

+8
-6
lines changed

5 files changed

+8
-6
lines changed

src/sys/aio.rs

+1
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ impl<'a> AioCb<'a> {
9797
/// Constructs a new `AioCb` with no associated buffer.
9898
///
9999
/// The resulting `AioCb` structure is suitable for use with `AioCb::fsync`.
100+
///
100101
/// * `fd` File descriptor. Required for all aio functions.
101102
/// * `prio` If POSIX Prioritized IO is supported, then the operation will
102103
/// be prioritized at the process's priority level minus `prio`

src/sys/mman.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,7 @@ libc_bitflags!{
100100
libc_enum!{
101101
/// Usage information for a range of memory to allow for performance optimizations by the kernel.
102102
///
103-
/// Used by [`madvise`].
104-
/// [`madvise`]: ./fn.madvise.html
103+
/// Used by [`madvise`](./fn.madvise.html).
105104
#[repr(i32)]
106105
pub enum MmapAdvise {
107106
/// No further special treatment. This is the default.

src/sys/quota.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ libc_enum!{
5959
QFMT_VFS_OLD,
6060
/// Use the standard VFS v0 quota format.
6161
///
62-
/// Handles 32-bit UIDs/GIDs and quota limits up to 2^42 bytes/2^32 inodes.
62+
/// Handles 32-bit UIDs/GIDs and quota limits up to 2<sup>32</sup> bytes/2<sup>32</sup> inodes.
6363
QFMT_VFS_V0,
6464
/// Use the VFS v1 quota format.
6565
///
66-
/// Handles 32-bit UIDs/GIDs and quota limits of 2^64 bytes/2^64 inodes.
66+
/// Handles 32-bit UIDs/GIDs and quota limits of 2<sup>64</sup> bytes/2<sup>64</sup> inodes.
6767
QFMT_VFS_V1,
6868
}
6969
}

src/sys/select.rs

+1
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ impl FdSet {
8787
/// # References
8888
///
8989
/// [select(2)](http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html)
90+
///
9091
/// [`FdSet::highest`]: struct.FdSet.html#method.highest
9192
pub fn select<'a, N, R, W, E, T>(nfds: N,
9293
readfds: R,

src/unistd.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,7 @@ pub fn write(fd: RawFd, buf: &[u8]) -> Result<usize> {
815815
}
816816

817817
/// Directive that tells [`lseek`] and [`lseek64`] what the offset is relative to.
818+
///
818819
/// [`lseek`]: ./fn.lseek.html
819820
/// [`lseek64`]: ./fn.lseek64.html
820821
#[repr(i32)]
@@ -847,7 +848,7 @@ pub enum Whence {
847848

848849
/// Move the read/write file offset.
849850
///
850-
/// See also [lseek(2)(http://pubs.opengroup.org/onlinepubs/9699919799/functions/lseek.html)
851+
/// See also [lseek(2)](http://pubs.opengroup.org/onlinepubs/9699919799/functions/lseek.html)
851852
pub fn lseek(fd: RawFd, offset: libc::off_t, whence: Whence) -> Result<libc::off_t> {
852853
let res = unsafe { libc::lseek(fd, offset, whence as i32) };
853854

@@ -1305,7 +1306,7 @@ pub fn pause() -> Result<()> {
13051306

13061307
/// Suspend execution for an interval of time
13071308
///
1308-
/// See also [sleep(2)(http://pubs.opengroup.org/onlinepubs/009695399/functions/sleep.html#tag_03_705_05)
1309+
/// See also [sleep(2)](http://pubs.opengroup.org/onlinepubs/009695399/functions/sleep.html#tag_03_705_05)
13091310
// Per POSIX, does not fail
13101311
#[inline]
13111312
pub fn sleep(seconds: libc::c_uint) -> c_uint {

0 commit comments

Comments
 (0)