summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryant Mairs <bryantmairs@google.com>2017-12-10 19:24:09 -0800
committerBryant Mairs <bryantmairs@google.com>2017-12-10 19:24:09 -0800
commit133e3501bca30edbc747bc8e83aca86f0908a8d2 (patch)
treeffa9c749693949056907754f1380b1bf7df0e090
parent2e8560edc1d8a041da3dbac8050a300958b9a087 (diff)
downloadnix-133e3501bca30edbc747bc8e83aca86f0908a8d2.zip
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.
-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
-rw-r--r--src/unistd.rs5
5 files changed, 8 insertions, 6 deletions
diff --git a/src/sys/aio.rs b/src/sys/aio.rs
index 6166467c..014ef673 100644
--- a/src/sys/aio.rs
+++ b/src/sys/aio.rs
@@ -97,6 +97,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 dc21899b..3fefddab 100644
--- a/src/sys/mman.rs
+++ b/src/sys/mman.rs
@@ -100,8 +100,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 77b13335..1564c412 100644
--- a/src/sys/quota.rs
+++ b/src/sys/quota.rs
@@ -59,11 +59,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 252fa6bc..f40b754a 100644
--- a/src/sys/select.rs
+++ b/src/sys/select.rs
@@ -87,6 +87,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,
diff --git a/src/unistd.rs b/src/unistd.rs
index c6ad6912..ea8db099 100644
--- a/src/unistd.rs
+++ b/src/unistd.rs
@@ -815,6 +815,7 @@ pub fn write(fd: RawFd, buf: &[u8]) -> Result<usize> {
}
/// Directive that tells [`lseek`] and [`lseek64`] what the offset is relative to.
+///
/// [`lseek`]: ./fn.lseek.html
/// [`lseek64`]: ./fn.lseek64.html
#[repr(i32)]
@@ -847,7 +848,7 @@ pub enum Whence {
/// Move the read/write file offset.
///
-/// See also [lseek(2)(http://pubs.opengroup.org/onlinepubs/9699919799/functions/lseek.html)
+/// See also [lseek(2)](http://pubs.opengroup.org/onlinepubs/9699919799/functions/lseek.html)
pub fn lseek(fd: RawFd, offset: libc::off_t, whence: Whence) -> Result<libc::off_t> {
let res = unsafe { libc::lseek(fd, offset, whence as i32) };
@@ -1305,7 +1306,7 @@ pub fn pause() -> Result<()> {
/// Suspend execution for an interval of time
///
-/// See also [sleep(2)(http://pubs.opengroup.org/onlinepubs/009695399/functions/sleep.html#tag_03_705_05)
+/// See also [sleep(2)](http://pubs.opengroup.org/onlinepubs/009695399/functions/sleep.html#tag_03_705_05)
// Per POSIX, does not fail
#[inline]
pub fn sleep(seconds: libc::c_uint) -> c_uint {