Skip to content

Commit a9a7e39

Browse files
committed
doc: update changelog
1 parent 87f54db commit a9a7e39

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

multiboot2/Changelog.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,34 @@
22

33
## Unreleased
44

5-
- **Breaking** All functions that returns something useful are now `#[must_use]`
6-
- **Breaking** More public fields in tags were replaced by public getters, such
5+
## 0.21.0 (2024-08-17)
6+
7+
This release contains a massive refactoring of various internals. Now, **all
8+
unit tests pass Miri**, thus we removed lots of undefined behaviour and
9+
increased the memory safety! 🎉 Only a small part of these internal refactorings
10+
leak to the public interface. If you don't provide external custom tags, you
11+
should be fine.
12+
13+
Please note that **all previous releases** must be considered unsafe, as they
14+
contain UB. However, it is never clear how UB results in immediate incorrect
15+
behaviour and it _might_ work. **Nevertheless, please migrate to the latest
16+
release and you'll be fine!**
17+
18+
- **Breaking:** All functions that returns something useful are
19+
now `#[must_use]`
20+
- **Breaking:** More public fields in tags were replaced by public getters, such
721
as `SmbiosTag::major()`
8-
- **BREAKING:** `multiboot2::{StringError};` -> \
9-
`multiboot2::util::{StringError};`
10-
- updated dependencies
11-
- MSRV is 1.75
22+
- **Breaking:** Methods of `InformationBuilder` to add tags now consume
23+
references instead of owned values
24+
- **Breaking:** The `BoxedDst` has been removed in favor of a normal Rust `Box`.
25+
This only affects you if you use the `builder` feature.
26+
- **Breaking:** MSRV is 1.75
27+
- **Breaking:** Introduced new `TagHeader` type as replacement for the `Tag`
28+
type that will be changed in the next step. `Tag` has been renamed to an
29+
internal-only `GenericTag` type.
30+
- Added missing `InformationBuilder::vbe_info_tag`
1231
- documentation enhancements
13-
- Introduced new `TagHeader` type as replacement for the `Tag` type that will
14-
be changed in the next step.
32+
- updated dependencies
1533

1634
## 0.20.2 (2024-05-26)
1735

0 commit comments

Comments
 (0)