Enable documentation for set_thread_id.

sunfishcode · Aug 27, 2023 · 6fdfd74 · 6fdfd74
1 parent 43a57e1
commit 6fdfd74
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -81,3 +81,7 @@ external-start = ["rustix/use-explicitly-provided-auxv", "rustix/runtime"]
 
 # Disable logging.
 max_level_off = ["log/max_level_off"]
+
+[package.metadata.docs.rs]
+features = ["set_thread_id"]
+rustdoc-args = ["--cfg", "doc_cfg"]
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,5 +1,6 @@
 #![doc = include_str!("../README.md")]
 #![deny(missing_docs)]
+#![cfg_attr(doc_cfg, feature(doc_cfg))]
 #![feature(asm_const)]
 #![feature(naked_functions)]
 #![feature(link_llvm_intrinsics)]

diff --git a/src/threads.rs b/src/threads.rs
@@ -232,6 +232,7 @@ pub fn current_thread_id() -> ThreadId {
 /// threads are created. `tid` must be the same value as what [`gettid`] would
 /// return.
 #[cfg(feature = "set_thread_id")]
+#[cfg_attr(doc_cfg, doc(cfg(feature = "set_thread_id")))]
 #[doc(hidden)]
 #[inline]
 pub unsafe fn set_current_thread_id_after_a_fork(tid: ThreadId) {