workspace: prepare new releases

phip1611 · phip1611 · commit cb3f83c7af83 · 2024-08-24T13:30:18.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+Please see:
+
+- [multiboot2/CHANGELOG.md](multiboot2/CHANGELOG.md)
+- [multiboot2-header/CHANGELOG.md](multiboot2-header/CHANGELOG.md)
+- [multiboot2-common/CHANGELOG.md](multiboot2-common/CHANGELOG.md)
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,6 +13,8 @@ exclude = [
 bitflags = "2.6.0"
 derive_more = { version = "~0.99.18", default-features = false, features = ["display"] }
 log = { version = "~0.4", default-features = false }
+multiboot2 = { version = "0.22.2", default-features = false }
+multiboot2-common = { version = "0.1.2", default-features = false }
 ptr_meta = { version = "~0.2", default-features = false }
 
 # This way, the corresponding crate dependency can be normalley referenced by
@@ -21,3 +23,4 @@ ptr_meta = { version = "~0.2", default-features = false }
 [patch.crates-io]
 multiboot2 = { path = "multiboot2" }
 multiboot2-common = { path = "multiboot2-common" }
+multiboot2-header = { path = "multiboot2-header" }
diff --git a/Changelog.md b/Changelog.md
diff --git a/README.md b/README.md
@@ -1,14 +1,10 @@
-# Multiboot2: MBI + Header
+# Rusty Wrappers for Multiboot2
 
-This repository contains the crates `multiboot2` and `multiboot2-header`.
-Please check their individual README-files ([multiboot2](multiboot2/README.md),
-[multiboot2-header](multiboot2-header/README.md)).
+## Repository Overview
 
-The `multiboot2` crate helps to parse the Multiboot2 information structure
-(MBI) and is relevant in kernels, that get booted by a bootloader such as
-GRUB, for example. `multiboot2-header` helps you to either build
-Multiboot2-headers yourself, or to parse Multiboot2 headers in custom bootloader
-or similar applications.
+- [`multiboot2`](./multiboot2/README.md)
+- [`multiboot2-header`](./multiboot2-header/README.md)
+- [`multiboot2-common`](./multiboot2-common/README.md)
 
 ## License
 
@@ -22,6 +18,6 @@ at your option.
 
 ### Contribution
 
-Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
-work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
-additional terms or conditions.
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
diff --git a/integration-test/bins/Cargo.lock b/integration-test/bins/Cargo.lock
diff --git a/multiboot2-common/CHANGELOG.md b/multiboot2-common/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog for Crate `multiboot2-common`
+
+## v0.1.2 (2024-08-24)
+
+- Documentation improvements
+-
+
+## 0.1.0 / 0.1.1 (2024-08-20)
+
+Initial release.
diff --git a/multiboot2-common/Cargo.toml b/multiboot2-common/Cargo.toml
@@ -3,7 +3,7 @@ name = "multiboot2-common"
 description = """
 Common helpers for the `multiboot2` and `multiboot2-header` crates.
 """
-version = "0.1.1"
+version = "0.1.2"
 authors = [
     "Philipp Schuster <phip1611@gmail.com>"
 ]
diff --git a/multiboot2-common/Changelog.md b/multiboot2-common/Changelog.md
diff --git a/multiboot2-common/src/lib.rs b/multiboot2-common/src/lib.rs
@@ -141,7 +141,7 @@
 //! [`Layout`] for the underlying type equals the one we manually used for the
 //! allocation.
 //!
-//! # Provided Abstractions
+//! # Architecture & Provided Abstractions
 //!
 //! Figure 2 in the [README](https://crates.io/crates/multiboot2-common)
 //! (currently not embeddable in lib.rs unfortunately) provides an overview of
diff --git a/multiboot2-header/CHANGELOG.md b/multiboot2-header/CHANGELOG.md
@@ -1,4 +1,8 @@
-# CHANGELOG for crate `multiboot2-header`
+# Changelog for Crate `multiboot2-header`
+
+## v0.5.1 (2024-08-24)
+
+- Documentation improvements
 
 ## v0.5.0 (2024-05-20)
 
diff --git a/multiboot2-header/Cargo.toml b/multiboot2-header/Cargo.toml
@@ -6,7 +6,7 @@ contained header tags. Usable in no_std environments, such as a
 bootloader. An optional builder feature also allows the construction of
 the corresponding structures.
 """
-version = "0.5.0"
+version = "0.5.1"
 authors = [
     "Philipp Schuster <phip1611@gmail.com>"
 ]
@@ -45,9 +45,9 @@ unstable = []
 [dependencies]
 derive_more.workspace = true
 log.workspace = true
+multiboot2-common.workspace = true
+multiboot2.workspace = true
 ptr_meta.workspace = true
-multiboot2 = { version = "0.22.1", default-features = false }
-multiboot2-common = "0.1.1"
 
 [package.metadata.docs.rs]
 all-features = true
diff --git a/multiboot2/CHANGELOG.md b/multiboot2/CHANGELOG.md
@@ -1,7 +1,8 @@
-# CHANGELOG for crate `multiboot2`
+# Changelog for Crate `multiboot2`
 
-## Unreleased
+## v0.22.2 (2024-08-24)
 
+- Documentation improvements
 - Improve debug formatting for EFIMemoryMapTag
 
 ## v0.22.1 (2024-08-20)
diff --git a/multiboot2/Cargo.toml b/multiboot2/Cargo.toml
@@ -6,7 +6,7 @@ structures and the contained information tags. Usable in `no_std` environments,
 such as a kernel. An optional builder feature also allows the construction of
 the corresponding structures.
 """
-version = "0.22.1"
+version = "0.22.2"
 authors = [
     "Philipp Oppermann <dev@phil-opp.com>",
     "Calvin Lee <cyrus296@gmail.com>",
@@ -46,8 +46,7 @@ bitflags.workspace = true
 derive_more.workspace = true
 log.workspace = true
 ptr_meta.workspace = true
-multiboot2-common = { version = "0.1.1", default-features = false }
-
+multiboot2-common.workspace = true
 # We only use a very basic type definition from this crate. To prevent MSRV
 # bumps from uefi-raw, I restrict this here. Upstream users are likely to have
 # two versions of this library in it, which is no problem, as we only use the

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ name = "multiboot2-common"`
`3`	`3`	`description = """`
`4`	`4`	Common helpers for the `multiboot2` and `multiboot2-header` crates.
`5`	`5`	`"""`
`6`		`-version = "0.1.1"`
	`6`	`+version = "0.1.2"`
`7`	`7`	`authors = [`
`8`	`8`	`"Philipp Schuster <[email protected]>"`
`9`	`9`	`]`