doc: include CHANGELOG.md as the documentation of crate::_changelog_

Author: yvt

src/r3/src/lib.rs

@@ -59,6 +59,10 @@ pub extern crate core;
 #[doc(hidden)]
 pub extern crate arrayvec;
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 #[macro_use]
 pub mod utils;
 #[macro_use]

src/r3_port_arm/src/lib.rs

@@ -29,6 +29,10 @@ pub extern crate r3_portkit;
 #[cfg(target_os = "none")]
 pub extern crate core;
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 #[cfg(target_os = "none")]
 mod arm;
 

src/r3_port_arm_m/src/lib.rs

@@ -15,6 +15,10 @@
 #![doc = include_str!("./lib.md")]
 #![no_std]
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 /// The [`r3::kernel::PortThreading`] implementation.
 #[doc(hidden)]
 pub mod threading {

src/r3_port_riscv/src/lib.rs

@@ -30,6 +30,10 @@ pub extern crate r3_portkit;
 #[doc(hidden)]
 pub extern crate core;
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 /// The Platform-Level Interrupt Controller driver.
 #[doc(hidden)]
 pub mod plic {

src/r3_port_std/src/lib.rs

@@ -23,6 +23,10 @@ use std::{
 };
 use try_mutex::TryMutex;
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 #[cfg(unix)]
 #[path = "threading_unix.rs"]
 mod threading;

src/r3_portkit/src/lib.rs

@@ -9,6 +9,10 @@
 #![deny(unsupported_naked_functions)]
 #![no_std]
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 #[macro_use]
 pub mod utils;
 

src/r3_support_rp2040/src/lib.rs

@@ -13,6 +13,10 @@
 #![deny(unsupported_naked_functions)]
 #![no_std]
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 pub mod clock;
 pub mod serial;
 pub mod stdout;

src/r3_support_rza1/src/lib.rs

@@ -24,6 +24,10 @@ pub extern crate r3_portkit;
 #[doc(hidden)]
 pub extern crate r3_port_arm;
 
+#[cfg(doc)]
+#[doc = include_str!("../CHANGELOG.md")]
+pub mod _changelog_ {}
+
 /// The RZ/A1 OS Timer driver.
 #[doc(hidden)]
 pub mod os_timer {