Skip to content

Commit 46b83a9

Browse files
committed
misc: prepare release
1 parent b0cc675 commit 46b83a9

File tree

8 files changed

+56
-14
lines changed

8 files changed

+56
-14
lines changed

Cargo.lock

Lines changed: 10 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ exclude = [
1313
bitflags = "2.6.0"
1414
derive_more = { version = "~0.99.18", default-features = false, features = ["display"] }
1515
log = { version = "~0.4", default-features = false }
16+
ptr_meta = { version = "~0.2", default-features = false }
1617

17-
# This way, the "multiboot2" dependency in the multiboot2-header crate can be
18-
# referenced by version, while still the repository version is used
19-
# transparently during local development.
18+
# This way, the corresponding crate dependency can be normalley referenced by
19+
# version, while still the repository version is used transparently during local
20+
# development.
2021
[patch.crates-io]
2122
multiboot2 = { path = "multiboot2" }
23+
multiboot2-common = { path = "multiboot2-common" }

integration-test/bins/Cargo.lock

Lines changed: 14 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

integration-test/bins/Cargo.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,5 @@ util = { path = "./util" }
2424
# transparently during local development.
2525
[patch.crates-io]
2626
multiboot2 = { path = "../../multiboot2" }
27+
multiboot2-common = { path = "../../multiboot2-common" }
28+
multiboot2-header = { path = "../../multiboot2-header" }

multiboot2-header/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description = """
44
Library with type definitions and parsing functions for Multiboot2 headers.
55
This library is `no_std` and can be used in bootloaders.
66
"""
7-
version = "0.4.0"
7+
version = "0.5.0"
88
authors = [
99
"Philipp Schuster <[email protected]>"
1010
]
@@ -43,7 +43,7 @@ unstable = []
4343
derive_more.workspace = true
4444
log.workspace = true
4545
ptr_meta.workspace = true
46-
multiboot2 = { version = "0.21.0", default-features = false }
46+
multiboot2 = { version = "0.22.0", default-features = false }
4747
multiboot2-common = "0.1.0"
4848

4949
[package.metadata.docs.rs]

multiboot2-header/Changelog.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# CHANGELOG for crate `multiboot2-header`
22

3-
## Unreleased
3+
## v0.5.0
4+
5+
This release contains a major refactoring of the internals, guaranteeing
6+
even more sanity checks for correct behaviour and lack of UB. In this release,
7+
the `Builder` was rewritten and lots of corresponding UB in certain
8+
corer-cases removed. Further, the builder's API was streamlined.
9+
10+
If you are interested in the internals of the major refactorings recently taken
11+
place, please head to the documentation of `multiboot2-common`.
412

513
- **Breaking** All functions that returns something useful are now `#[must_use]`
14+
- **Breaking** The builder type is now just called `Builder`. This needs the
15+
`builder` feature.
616
- Updated to latest `multiboot2` dependency
717

818
## 0.4.0 (2024-05-01)

multiboot2/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Multiboot2-compliant bootloaders, such as GRUB. It supports all tags from the
66
specification including full support for the sections of ELF files. This library
77
is `no_std` and can be used in a Multiboot2-kernel.
88
"""
9-
version = "0.21.0"
9+
version = "0.22.0"
1010
authors = [
1111
"Philipp Oppermann <[email protected]>",
1212
"Calvin Lee <[email protected]>",

multiboot2/Changelog.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# CHANGELOG for crate `multiboot2`
22

3-
## Unreleased
3+
## v0.22.0
4+
5+
This release contains another major refactoring of the internals, guaranteeing
6+
even more sanity checks for correct behaviour and lack of UB. In this release,
7+
the `Builder` was rewritten and lots of corresponding UB in certain
8+
corer-cases removed. Further, the builder's API was streamlined.
49

510
If you are interested in the internals of the major refactorings recently taken
611
place, please head to the documentation of `multiboot2-common`.
@@ -29,12 +34,15 @@ base is in excellent shape!
2934

3035
## 0.21.0 (2024-08-17)
3136

32-
This release contains a massive refactoring of various internals. Now, **all
33-
unit tests pass Miri**, thus we removed lots of undefined behaviour and
37+
This release contains a massive refactoring of various internals. Now, **almost
38+
**unit tests pass Miri**, thus we removed lots of undefined behaviour and
3439
increased the memory safety! 🎉 Only a small part of these internal refactorings
3540
leak to the public interface. If you don't use external custom tags, you
3641
should be fine from any refactorings.
3742

43+
_**Edit**: The builder and the framebuffer still contain some UB. This is fixed
44+
in the next release._
45+
3846
Please note that **all previous releases** must be considered unsafe, as they
3947
contain UB. However, it is never clear how UB results in immediate incorrect
4048
behaviour and it _might_ work. **Nevertheless, please migrate to the latest

0 commit comments

Comments
 (0)