runtime: fix stability feature flags for docs

Fixes: #6907
tokio-rs · Oct 18, 2024 · 4e312c4 · 4e312c4
1 parent 1656d8e
commit 4e312c4
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs
@@ -351,8 +351,10 @@
 //! - [`task::Builder`]
 //! - Some methods on [`task::JoinSet`]
 //! - [`runtime::RuntimeMetrics`]
+//! - [`runtime::Builder::on_task_spawn`]
+//! - [`runtime::Builder::on_task_terminate`]
 //! - [`runtime::Builder::unhandled_panic`]
-//! - [`task::Id`]
+//! - [`runtime::TaskMeta`]
 //!
 //! This flag enables **unstable** features. The public API of these features
 //! may break in 1.x releases. To enable these features, the `--cfg

diff --git a/tokio/src/runtime/builder.rs b/tokio/src/runtime/builder.rs
@@ -728,6 +728,7 @@ impl Builder {
     /// # }
     /// ```
     #[cfg(all(not(loom), tokio_unstable))]
+    #[cfg_attr(docsrs, doc(cfg(all(not(loom), tokio_unstable))))]
     pub fn on_task_spawn<F>(&mut self, f: F) -> &mut Self
     where
         F: Fn(&TaskMeta<'_>) + Send + Sync + 'static,
@@ -770,6 +771,7 @@ impl Builder {
     /// # }
     /// ```
     #[cfg(all(not(loom), tokio_unstable))]
+    #[cfg_attr(docsrs, doc(cfg(all(not(loom), tokio_unstable))))]
     pub fn on_task_terminate<F>(&mut self, f: F) -> &mut Self
     where
         F: Fn(&TaskMeta<'_>) + Send + Sync + 'static,

diff --git a/tokio/src/runtime/mod.rs b/tokio/src/runtime/mod.rs
@@ -384,8 +384,9 @@ cfg_rt! {
 
     mod task_hooks;
     pub(crate) use task_hooks::{TaskHooks, TaskCallback};
-    #[cfg(tokio_unstable)]
-    pub use task_hooks::TaskMeta;
+    cfg_unstable! {
+        pub use task_hooks::TaskMeta;
+    }
     #[cfg(not(tokio_unstable))]
     pub(crate) use task_hooks::TaskMeta;
 

diff --git a/tokio/src/runtime/runtime.rs b/tokio/src/runtime/runtime.rs
@@ -119,6 +119,7 @@ pub enum RuntimeFlavor {
     MultiThread,
     /// The flavor that executes tasks across multiple threads.
     #[cfg(tokio_unstable)]
+    #[cfg_attr(docsrs, doc(cfg(tokio_unstable)))]
     MultiThreadAlt,
 }
 

diff --git a/tokio/src/runtime/task/mod.rs b/tokio/src/runtime/task/mod.rs
@@ -391,7 +391,6 @@ impl<S: 'static> Task<S> {
         ///
         /// [task ID]: crate::task::Id
         #[cfg(tokio_unstable)]
-        #[cfg_attr(docsrs, doc(cfg(tokio_unstable)))]
         pub(crate) fn id(&self) -> crate::task::Id {
             // Safety: The header pointer is valid.
             unsafe { Header::get_id(self.raw.header_ptr()) }