Merge pull request #96 from compio-rs/doc/refurnish

Add `doc(cfg())` support

compio-buf/Cargo.toml

@@ -12,6 +12,7 @@ repository = { workspace = true }
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg docsrs"]
 
 [dependencies]
 bumpalo = { version = "3", optional = true }

compio-buf/src/lib.rs

@@ -4,6 +4,7 @@
 //! crate defines [`IoBuf`] and [`IoBufMut`] traits which are implemented by
 //! buffer types that respect the safety contract.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(feature = "allocator_api", feature(allocator_api))]
 #![cfg_attr(feature = "read_buf", feature(read_buf))]
 #![cfg_attr(feature = "try_trait_v2", feature(try_trait_v2, try_trait_v2_residual))]

compio-driver/Cargo.toml

@@ -12,6 +12,7 @@ repository = { workspace = true }
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg docsrs"]
 default-target = "x86_64-pc-windows-msvc"
 targets = [
     "x86_64-pc-windows-msvc",
@@ -36,7 +37,7 @@ slab = "0.4"
 socket2 = { version = "0.5", features = ["all"] }
 
 # Windows specific dependencies
-[target.'cfg(target_os = "windows")'.dependencies]
+[target.'cfg(windows)'.dependencies]
 compio-buf = { workspace = true, features = ["arrayvec"] }
 # may be excluded from linking if the unstable equivalent is used
 aligned-array = "1"

compio-driver/src/iour/mod.rs

@@ -1,4 +1,4 @@
-#[doc(no_inline)]
+#[cfg_attr(all(doc, docsrs), doc(cfg(all())))]
 pub use std::os::fd::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
 use std::{collections::VecDeque, io, pin::Pin, task::Poll, time::Duration};
 

compio-driver/src/lib.rs

@@ -1,6 +1,7 @@
 //! The platform-specified driver.
 //! Some types differ by compilation target.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(feature = "once_cell_try", feature(once_cell_try))]
 #![warn(missing_docs)]
 
@@ -18,10 +19,11 @@ use slab::Slab;
 
 pub mod op;
 #[cfg(unix)]
+#[cfg_attr(docsrs, doc(cfg(all())))]
 mod unix;
 
 cfg_if::cfg_if! {
-    if #[cfg(target_os = "windows")] {
+    if #[cfg(windows)] {
         #[path = "iocp/mod.rs"]
         mod sys;
     } else if #[cfg(all(target_os = "linux", feature = "io-uring"))] {
@@ -35,7 +37,7 @@ cfg_if::cfg_if! {
 
 pub use sys::*;
 
-#[cfg(target_os = "windows")]
+#[cfg(windows)]
 #[macro_export]
 #[doc(hidden)]
 macro_rules! syscall {

compio-driver/src/op.rs

@@ -6,7 +6,7 @@
 use compio_buf::{BufResult, IntoInner, IoBuf, IoBufMut, SetBufInit};
 use socket2::SockAddr;
 
-#[cfg(target_os = "windows")]
+#[cfg(windows)]
 pub use crate::sys::op::ConnectNamedPipe;
 pub use crate::sys::op::{
     Accept, Recv, RecvFrom, RecvFromVectored, RecvVectored, Send, SendTo, SendToVectored,

compio-driver/src/poll/mod.rs

@@ -1,4 +1,4 @@
-#[doc(no_inline)]
+#[cfg_attr(all(doc, docsrs), doc(cfg(all())))]
 pub use std::os::fd::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
 use std::{
     collections::{HashMap, HashSet, VecDeque},

compio-fs/Cargo.toml

@@ -12,6 +12,7 @@ repository = { workspace = true }
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg docsrs"]
 
 [dependencies]
 # Workspace dependencies
@@ -20,7 +21,7 @@ compio-driver = { workspace = true }
 compio-runtime = { workspace = true, optional = true }
 
 # Windows specific dependencies
-[target.'cfg(target_os = "windows")'.dependencies]
+[target.'cfg(windows)'.dependencies]
 widestring = "1"
 windows-sys = { version = "0.48", features = [
     "Win32_Foundation",
@@ -31,7 +32,7 @@ windows-sys = { version = "0.48", features = [
 ] }
 
 # Windows specific dev dependencies
-[target.'cfg(target_os = "windows")'.dev-dependencies]
+[target.'cfg(windows)'.dev-dependencies]
 windows-sys = { version = "0.48", features = ["Win32_Security_Authorization"] }
 
 # Unix specific dependencies

compio-fs/src/file.rs

@@ -25,7 +25,7 @@ pub struct File {
     attacher: Attacher,
 }
 
-#[cfg(target_os = "windows")]
+#[cfg(windows)]
 fn file_with_options(
     path: impl AsRef<Path>,
     mut options: std::fs::OpenOptions,
@@ -38,7 +38,7 @@ fn file_with_options(
     options.open(path)
 }
 
-#[cfg(not(target_os = "windows"))]
+#[cfg(not(windows))]
 fn file_with_options(
     path: impl AsRef<Path>,
     mut options: std::fs::OpenOptions,

compio-fs/src/lib.rs

@@ -1,5 +1,6 @@
 //! Filesystem manipulation operations.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(feature = "allocator_api", feature(allocator_api))]
 #![warn(missing_docs)]
 
@@ -9,5 +10,5 @@ pub use file::*;
 mod open_options;
 pub use open_options::*;
 
-#[cfg(target_os = "windows")]
+#[cfg(windows)]
 pub mod named_pipe;

compio-net/Cargo.toml

@@ -12,6 +12,7 @@ repository = { workspace = true }
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg docsrs"]
 
 [dependencies]
 # Workspace dependencies

compio-net/src/lib.rs

@@ -2,6 +2,7 @@
 //!
 //! Currently, TCP/UDP/Unix socket are implemented.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![warn(missing_docs)]
 
 mod socket;

compio-net/src/socket.rs

@@ -84,7 +84,7 @@ impl Socket {
         self.attach()?;
         let op = Connect::new(self.as_raw_fd(), addr.clone());
         let BufResult(res, _op) = submit(op).await;
-        #[cfg(target_os = "windows")]
+        #[cfg(windows)]
         {
             res?;
             _op.update_context()?;
@@ -113,7 +113,7 @@ impl Socket {
         Ok((accept_sock, addr))
     }
 
-    #[cfg(all(feature = "runtime", target_os = "windows"))]
+    #[cfg(all(feature = "runtime", windows))]
     pub async fn accept(&self) -> io::Result<(Self, SockAddr)> {
         self.attach()?;
         let local_addr = self.local_addr()?;

compio-net/src/tcp.rs

@@ -149,7 +149,7 @@ impl TcpStream {
         use std::net::{Ipv4Addr, Ipv6Addr, SocketAddrV4, SocketAddrV6};
 
         super::each_addr_async(addr, |addr| async move {
-            let socket = if cfg!(target_os = "windows") {
+            let socket = if cfg!(windows) {
                 let bind_addr = if addr.is_ipv4() {
                     SockAddr::from(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0))
                 } else if addr.is_ipv6() {

compio-runtime/Cargo.toml

@@ -13,6 +13,7 @@ repository = { workspace = true }
 [package.metadata.docs.rs]
 all-features = true
 default-target = "x86_64-pc-windows-msvc"
+rustdoc-args = ["--cfg docsrs"]
 targets = [
     "x86_64-pc-windows-msvc",
     "x86_64-unknown-linux-gnu",
@@ -39,7 +40,7 @@ slab = { version = "0.4", optional = true }
 smallvec = "1"
 
 # Windows specific dependencies
-[target.'cfg(target_os = "windows")'.dependencies]
+[target.'cfg(windows)'.dependencies]
 windows-sys = { version = "0.48", features = ["Win32_System_IO"] }
 
 # Unix specific dependencies

compio-runtime/src/attacher.rs

@@ -50,7 +50,7 @@ impl Attacher {
     /// * io-uring/polling: it will try to attach in the current thread if
     ///   needed.
     pub fn try_clone(&self, source: &impl AsRawFd) -> io::Result<Self> {
-        if cfg!(target_os = "windows") {
+        if cfg!(windows) {
             Ok(self.clone())
         } else {
             let new_self = Self::new();

compio-runtime/src/event/mod.rs

@@ -3,7 +3,7 @@
 //! Only for waking up the driver.
 
 cfg_if::cfg_if! {
-    if #[cfg(target_os = "windows")] {
+    if #[cfg(windows)] {
         mod iocp;
         pub use iocp::*;
     } else if #[cfg(any(

compio-runtime/src/lib.rs

@@ -11,6 +11,7 @@
 //! ```
 
 #![cfg_attr(feature = "once_cell_try", feature(once_cell_try))]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![warn(missing_docs)]
 
 mod attacher;

compio-signal/Cargo.toml

@@ -12,13 +12,14 @@ repository = { workspace = true }
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg docsrs"]
 
 [dependencies]
 # Workspace dependencies
 compio-runtime = { workspace = true, features = ["event"] }
 
 # Windows specific dependencies
-[target.'cfg(target_os = "windows")'.dependencies]
+[target.'cfg(windows)'.dependencies]
 compio-driver = { workspace = true }
 once_cell = "1"
 slab = "0.4"

compio-signal/src/lib.rs

@@ -13,18 +13,19 @@
 //! })
 //! ```
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(feature = "lazy_cell", feature(lazy_cell))]
 #![warn(missing_docs)]
 
-#[cfg(target_os = "windows")]
+#[cfg(windows)]
 pub mod windows;
 
 #[cfg(unix)]
 pub mod unix;
 
 /// Completes when a "ctrl-c" notification is sent to the process.
 pub async fn ctrl_c() -> std::io::Result<()> {
-    #[cfg(target_os = "windows")]
+    #[cfg(windows)]
     {
         windows::ctrl_c().await
     }

compio/Cargo.toml

@@ -13,6 +13,7 @@ repository = { workspace = true }
 [package.metadata.docs.rs]
 all-features = true
 default-target = "x86_64-pc-windows-msvc"
+rustdoc-args = ["--cfg docsrs"]
 targets = [
     "x86_64-pc-windows-msvc",
     "x86_64-unknown-linux-gnu",

compio/benches/named_pipe.rs

@@ -25,7 +25,7 @@ fn basic(c: &mut Criterion) {
             .build()
             .unwrap();
         b.to_async(&runtime).iter(|| async {
-            #[cfg(target_os = "windows")]
+            #[cfg(windows)]
             {
                 use tokio::{
                     io::{AsyncReadExt, AsyncWriteExt},
@@ -52,7 +52,7 @@ fn basic(c: &mut Criterion) {
 
     group.bench_function("compio", |b| {
         b.to_async(CompioRuntime).iter(|| async {
-            #[cfg(target_os = "windows")]
+            #[cfg(windows)]
             {
                 use compio::{
                     buf::BufResult,

compio/examples/named_pipe.rs

@@ -1,6 +1,6 @@
 #[compio::main(crate = "compio")]
 async fn main() {
-    #[cfg(target_os = "windows")]
+    #[cfg(windows)]
     {
         use compio::{
             buf::BufResult,

compio/src/lib.rs

@@ -19,6 +19,7 @@
 //! # })
 //! ```
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![warn(missing_docs)]
 
 #[doc(no_inline)]