Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP use doc_cfg for cross-platform documentation #1019

Closed
wants to merge 1 commit into from
Closed

WIP use doc_cfg for cross-platform documentation #1019

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ exclude = [
"/bors.toml"
]

[package.metadata.docs.rs]
features = ["nightly-docs"]

[features]
# For building documentation only; no functional change to the library.
nightly-docs = []

[dependencies]
libc = { git = "https://github.com/rust-lang/libc" }
bitflags = "1.0"
Expand Down
9 changes: 7 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
#![deny(unstable_features)]
#![deny(missing_copy_implementations)]
#![deny(missing_debug_implementations)]
#![cfg_attr(feature = "nightly-docs", feature(doc_cfg))]

// External crates
#[macro_use]
Expand Down Expand Up @@ -67,8 +68,12 @@ pub mod sched;
pub mod sys;
// This can be implemented for other platforms as soon as libc
// provides bindings for them.
#[cfg(all(target_os = "linux",
any(target_arch = "x86", target_arch = "x86_64")))]
#[cfg(any(all(target_os = "linux",
any(target_arch = "x86", target_arch = "x86_64")),
all(feature = "nightly-docs", rustdoc)))]
#[cfg_attr(feature = "nightly-docs",
doc(cfg(all(target_os = "linux",
any(target_arch = "x86", target_arch = "x86_64")))))]
pub mod ucontext;
pub mod unistd;

Expand Down
14 changes: 14 additions & 0 deletions src/sys/ioctl/bsd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,20 @@ macro_rules! ioc {
/// ioctl_write_int_bad!(kvm_create_vm, request_code_none!(KVMIO, 0x03));
/// # fn main() {}
/// ```
#[cfg(any(target_os = "dragonfly",
target_os = "freebsd",
target_os = "ios",
target_os = "macos",
target_os = "netbsd",
target_os = "openbsd",
all(feature = "nightly-docs", rustdoc)))]
#[cfg_attr(feature = "nightly-docs",
doc(cfg(any(target_os = "dragonfly",
target_os = "freebsd",
target_os = "ios",
target_os = "macos",
target_os = "netbsd",
target_os = "openbsd"))))]
#[macro_export]
macro_rules! request_code_none {
($g:expr, $n:expr) => (ioc!($crate::sys::ioctl::VOID, $g, $n, 0))
Expand Down
10 changes: 9 additions & 1 deletion src/sys/ioctl/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,15 @@ pub use self::linux::*;
target_os = "ios",
target_os = "macos",
target_os = "netbsd",
target_os = "openbsd"))]
target_os = "openbsd",
all(feature = "nightly-docs", rustdoc)))]
#[cfg_attr(feature = "nightly-docs",
doc(cfg(any(target_os = "dragonfly",
target_os = "freebsd",
target_os = "ios",
target_os = "macos",
target_os = "netbsd",
target_os = "openbsd"))))]
#[macro_use]
mod bsd;

Expand Down
12 changes: 10 additions & 2 deletions src/ucontext.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,16 @@ use sys::signal::SigSet;
#[derive(Clone, Copy)]
#[allow(missing_debug_implementations)]
pub struct UContext {
#[cfg(all(target_os = "linux",
any(target_arch = "x86", target_arch = "x86_64")))]
context: libc::ucontext_t,
}

impl UContext {
#[cfg(not(target_env = "musl"))]
#[cfg(any(not(target_env = "musl"),
all(feature = "nightly-docs", rustdoc)))]
#[cfg_attr(feature = "nightly-docs",
doc(cfg(not(target_env = "musl"))))]
pub fn get() -> Result<UContext> {
let mut context: libc::ucontext_t = unsafe { mem::uninitialized() };
let res = unsafe {
Expand All @@ -22,7 +27,10 @@ impl UContext {
Errno::result(res).map(|_| UContext { context: context })
}

#[cfg(not(target_env = "musl"))]
#[cfg(any(not(target_env = "musl"),
all(feature = "nightly-docs", rustdoc)))]
#[cfg_attr(feature = "nightly-docs",
doc(cfg(not(target_env = "musl"))))]
pub fn set(&self) -> Result<()> {
let res = unsafe {
libc::setcontext(&self.context as *const libc::ucontext_t)
Expand Down
16 changes: 12 additions & 4 deletions src/unistd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,10 @@ pub fn getpgrp() -> Pid {
///
/// No error handling is required as a thread id should always exist for any
/// process, even if threads are not being used.
#[cfg(any(target_os = "linux", target_os = "android"))]
#[cfg(any(any(target_os = "linux", target_os = "android"),
all(feature = "nightly-docs", rustdoc)))]
#[cfg_attr(feature = "nightly-docs",
doc(cfg(any(target_os = "linux", target_os = "android"))))]
#[inline]
pub fn gettid() -> Pid {
Pid(unsafe { libc::syscall(libc::SYS_gettid) as pid_t })
Expand Down Expand Up @@ -763,9 +766,14 @@ pub fn execvpe(filename: &CString, args: &[CString], env: &[CString]) -> Result<
// Note for NetBSD and OpenBSD: although rust-lang/libc includes it (under
// unix/bsd/netbsdlike/) fexecve is not currently implemented on NetBSD nor on
// OpenBSD.
#[cfg(any(target_os = "android",
target_os = "linux",
target_os = "freebsd"))]
#[cfg(any(any(target_os = "android",
target_os = "linux",
target_os = "freebsd"),
all(feature = "nightly-docs", rustdoc)))]
#[cfg_attr(feature = "nightly-docs",
doc(cfg(any(target_os = "android",
target_os = "linux",
target_os = "freebsd"))))]
#[inline]
pub fn fexecve(fd: RawFd, args: &[CString], env: &[CString]) -> Result<Void> {
let args_p = to_exec_array(args);
Expand Down