Skip to content

Commit daeaaf5

Browse files
committed
doc: streamline changelog
1 parent ff90edb commit daeaaf5

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

uefi/CHANGELOG.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,28 @@
1111
- `PcrEvent`/`PcrEventInputs` impl `Align`, `Eq`, and `PartialEq`.
1212
- Added `PcrEvent::new_in_box` and `PcrEventInputs::new_in_box`.
1313
- `VariableKey` impls `Clone`, `Eq`, `PartialEq`, `Ord`, `PartialOrd`, and `Hash`.
14+
- The traits `MemoryMap` and `MemoryMapMut` have been introduced together with
15+
the implementations `MemoryMapRef`, `MemoryMapRefMut`, and `MemoryMapOwned`.
16+
This comes with some changes. Read below. We recommend to directly use the
17+
implementations instead of the traits.
1418

1519
## Changed
1620
- **Breaking:** `uefi::helpers::init` no longer takes an argument.
1721
- The lifetime of the `SearchType` returned from
1822
`BootServices::register_protocol_notify` is now tied to the protocol GUID.
19-
- The traits `MemoryMap` and `MemoryMapMut` have been introduced together with
20-
the implementations `MemoryMapRef`, `MemoryMapRefMut`, and `MemoryMapOwned`.
2123
The old `MemoryMap` was renamed to `MemoryMapOwned`.
2224
- `pub fn memory_map(&self, mt: MemoryType) -> Result<MemoryMap>` now returns
2325
a `MemoryMapOwned`.
2426
- **Breaking:** `PcrEvent::new_in_buffer` and `PcrEventInputs::new_in_buffer`
2527
now take an initialized buffer (`[u8`] instead of `[MaybeUninit<u8>]`), and if
2628
the buffer is too small the required size is returned in the error data.
27-
- **Breaking** Exports of Memory Map-related types from `uefi::table::boot` are
29+
- **Breaking:** The type `MemoryMap` was renamed to `MemoryMapOwned`. `MemoryMap`
30+
is now a trait. Read the [documentation](https://docs.rs/uefi/latest/uefi/) of the
31+
`uefi > mem > memory_map` module to learn more.
32+
- **Breaking:** Exports of Memory Map-related types from `uefi::table::boot` are
2833
now removed. Use `uefi::mem::memory_map` instead. The patch you have to apply
2934
to the `use` statements of your code might look as follows:
3035
```diff
31-
1c1,2
3236
< use uefi::table::boot::{BootServices, MemoryMap, MemoryMapMut, MemoryType};
3337
---
3438
> use uefi::mem::memory_map::{MemoryMap, MemoryMapMut, MemoryType};

0 commit comments

Comments
 (0)