Browse Source

workspace: prepare new releases

Philipp Schuster 6 months ago
parent
commit
cb3f83c7af

+ 5 - 0
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)

+ 3 - 3
Cargo.lock

@@ -27,7 +27,7 @@ checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24"
 
 [[package]]
 name = "multiboot2"
-version = "0.22.1"
+version = "0.22.2"
 dependencies = [
  "bitflags",
  "derive_more",
@@ -39,7 +39,7 @@ dependencies = [
 
 [[package]]
 name = "multiboot2-common"
-version = "0.1.1"
+version = "0.1.2"
 dependencies = [
  "derive_more",
  "ptr_meta",
@@ -47,7 +47,7 @@ dependencies = [
 
 [[package]]
 name = "multiboot2-header"
-version = "0.5.0"
+version = "0.5.1"
 dependencies = [
  "derive_more",
  "log",

+ 3 - 0
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" }

+ 0 - 3
Changelog.md

@@ -1,3 +0,0 @@
-Please see:
-- [multiboot2/Changelog.md](multiboot2/Changelog.md)
-- [multiboot2-header/Changelog.md](multiboot2-header/Changelog.md)

+ 8 - 12
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.

+ 3 - 3
integration-test/bins/Cargo.lock

@@ -96,7 +96,7 @@ dependencies = [
 
 [[package]]
 name = "multiboot2"
-version = "0.22.1"
+version = "0.22.2"
 dependencies = [
  "bitflags 2.6.0",
  "derive_more",
@@ -108,7 +108,7 @@ dependencies = [
 
 [[package]]
 name = "multiboot2-common"
-version = "0.1.1"
+version = "0.1.2"
 dependencies = [
  "derive_more",
  "ptr_meta",
@@ -116,7 +116,7 @@ dependencies = [
 
 [[package]]
 name = "multiboot2-header"
-version = "0.5.0"
+version = "0.5.1"
 dependencies = [
  "derive_more",
  "log",

+ 10 - 0
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.

+ 1 - 1
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 <[email protected]>"
 ]

+ 0 - 5
multiboot2-common/Changelog.md

@@ -1,5 +0,0 @@
-# CHANGELOG for crate `multiboot2`
-
-## 0.1.0 / 0.1.1 (2024-08-20)
-
-Initial release.

+ 1 - 1
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

+ 5 - 1
multiboot2-header/Changelog.md → 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)
 

+ 3 - 3
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 <[email protected]>"
 ]
@@ -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

+ 3 - 2
multiboot2/Changelog.md → 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)

+ 2 - 3
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 <[email protected]>",
     "Calvin Lee <[email protected]>",
@@ -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