From af0e8b50f484a8f0424e09f9ac070955e385f388 Mon Sep 17 00:00:00 2001
From: Philipp Schuster <phip1611@gmail.com>
Date: Wed, 18 Sep 2024 11:02:59 +0200
Subject: [PATCH] multiboot2-header: talk about yanked versions in CHANGELOG.md

---
 multiboot2-header/CHANGELOG.md | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/multiboot2-header/CHANGELOG.md b/multiboot2-header/CHANGELOG.md
index e306477c..8ddb96c7 100644
--- a/multiboot2-header/CHANGELOG.md
+++ b/multiboot2-header/CHANGELOG.md
@@ -29,24 +29,28 @@ place, please head to the documentation of `multiboot2-common`.
   changed.
 - Updated to latest `multiboot2` dependency
 
-## 0.4.0 (2024-05-01)
+All previous versions have been marked as **YANKED**. `0.5.0` is the first
+version where all unit tests are passed by Miri, i.e., the first version
+without Undefined Behavior.
+
+## 0.4.0 (2024-05-01) (**YANKED**)
 
 - added `EndHeaderTag::default()`
 - MSRV is 1.70
 - Can add multiple `TagType::Smbios` tags in the builder.
 
-## 0.3.2 (2023-11-30)
+## 0.3.2 (2023-11-30) (**YANKED**)
 
 - **BREAKING** bumped `multiboot2` dependency to `v0.19.0`
 - the `multiboot2` dependency doesn't pull in the `multiboot2/builder` feature
   anymore
 - doc update
 
-## 0.3.1 (2023-06-28)
+## 0.3.1 (2023-06-28) (**YANKED**)
 
 - doc update
 
-## 0.3.0 (2023-06-23)
+## 0.3.0 (2023-06-23) (**YANKED**)
 
 - **BREAKING** MSRV is 1.68.0 (UPDATE: This is actually 1.69.)
 - **BREAKING** renamed the `std` feature to `alloc`
@@ -59,7 +63,7 @@ place, please head to the documentation of `multiboot2-common`.
 - added the optional `unstable` feature (requires nightly)
     - implement `core::error::Error` for `LoadError`
 
-## 0.2.0 (2022-05-03)
+## 0.2.0 (2022-05-03) (**YANKED**)
 
 - **BREAKING** renamed `EntryHeaderTag` to `EntryAddressHeaderTag`
 - **BREAKING** some paths changed from `multiboot2_header::header`
@@ -67,7 +71,7 @@ place, please head to the documentation of `multiboot2-common`.
   -> thus, import paths are much more logically now
 - internal code improvements
 
-## 0.1.1 (2022-05-02)
+## 0.1.1 (2022-05-02) (**YANKED**)
 
 - fixed a bug that prevented the usage of the crate in `no_std` environments
 - added a new default `builder`-feature to Cargo which requires the `alloc`
@@ -75,7 +79,7 @@ place, please head to the documentation of `multiboot2-common`.
   (this feature can be disabled which will also remove the dependency to
   the `alloc` crate)
 
-## 0.1.0 (2021-10-08)
+## 0.1.0 (2021-10-08) (**YANKED**)
 
 - initial release