summaryrefslogtreecommitdiff
path: root/src/sys
diff options
context:
space:
mode:
authorbors[bot] <bors[bot]@users.noreply.github.com>2017-12-11 04:05:12 +0000
committerbors[bot] <bors[bot]@users.noreply.github.com>2017-12-11 04:05:12 +0000
commitb957a7a801635cbf5b7b4f8bae67108a7117e0fd (patch)
tree31f5a5b09bf5cfae8e2ba457973281974200cf8d /src/sys
parente1ce3619bd3013d345a36d0a7b908c243788471e (diff)
parent133e3501bca30edbc747bc8e83aca86f0908a8d2 (diff)
downloadnix-b957a7a801635cbf5b7b4f8bae67108a7117e0fd.zip
Merge #806
806: Cleanup all doc warnings r=asomers a=Susurrus With the impending switch to Pulldown as the default doc generator, warnings have been enabled for incompatible syntax. This fixes all of said warnings.
Diffstat (limited to 'src/sys')
-rw-r--r--src/sys/aio.rs1
-rw-r--r--src/sys/mman.rs3
-rw-r--r--src/sys/quota.rs4
-rw-r--r--src/sys/select.rs1
4 files changed, 5 insertions, 4 deletions
diff --git a/src/sys/aio.rs b/src/sys/aio.rs
index fbae4443..909b59d7 100644
--- a/src/sys/aio.rs
+++ b/src/sys/aio.rs
@@ -98,6 +98,7 @@ impl<'a> AioCb<'a> {
/// Constructs a new `AioCb` with no associated buffer.
///
/// The resulting `AioCb` structure is suitable for use with `AioCb::fsync`.
+ ///
/// * `fd` File descriptor. Required for all aio functions.
/// * `prio` If POSIX Prioritized IO is supported, then the operation will
/// be prioritized at the process's priority level minus `prio`
diff --git a/src/sys/mman.rs b/src/sys/mman.rs
index a32cd54a..65f6c59d 100644
--- a/src/sys/mman.rs
+++ b/src/sys/mman.rs
@@ -101,8 +101,7 @@ libc_bitflags!{
libc_enum!{
/// Usage information for a range of memory to allow for performance optimizations by the kernel.
///
- /// Used by [`madvise`].
- /// [`madvise`]: ./fn.madvise.html
+ /// Used by [`madvise`](./fn.madvise.html).
#[repr(i32)]
pub enum MmapAdvise {
/// No further special treatment. This is the default.
diff --git a/src/sys/quota.rs b/src/sys/quota.rs
index abe114f0..a85d9e30 100644
--- a/src/sys/quota.rs
+++ b/src/sys/quota.rs
@@ -60,11 +60,11 @@ libc_enum!{
QFMT_VFS_OLD,
/// Use the standard VFS v0 quota format.
///
- /// Handles 32-bit UIDs/GIDs and quota limits up to 2^42 bytes/2^32 inodes.
+ /// Handles 32-bit UIDs/GIDs and quota limits up to 2<sup>32</sup> bytes/2<sup>32</sup> inodes.
QFMT_VFS_V0,
/// Use the VFS v1 quota format.
///
- /// Handles 32-bit UIDs/GIDs and quota limits of 2^64 bytes/2^64 inodes.
+ /// Handles 32-bit UIDs/GIDs and quota limits of 2<sup>64</sup> bytes/2<sup>64</sup> inodes.
QFMT_VFS_V1,
}
}
diff --git a/src/sys/select.rs b/src/sys/select.rs
index 9a429103..6fe176ae 100644
--- a/src/sys/select.rs
+++ b/src/sys/select.rs
@@ -88,6 +88,7 @@ impl FdSet {
/// # References
///
/// [select(2)](http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html)
+///
/// [`FdSet::highest`]: struct.FdSet.html#method.highest
pub fn select<'a, N, R, W, E, T>(nfds: N,
readfds: R,