Skip to content

Commit

Permalink
doc: streamline changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
phip1611 committed Jul 30, 2024
1 parent 8e0320d commit 7d9c1e3
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions uefi/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,28 @@
- `PcrEvent`/`PcrEventInputs` impl `Align`, `Eq`, and `PartialEq`.
- Added `PcrEvent::new_in_box` and `PcrEventInputs::new_in_box`.
- `VariableKey` impls `Clone`, `Eq`, `PartialEq`, `Ord`, `PartialOrd`, and `Hash`.
- The traits `MemoryMap` and `MemoryMapMut` have been introduced together with
the implementations `MemoryMapRef`, `MemoryMapRefMut`, and `MemoryMapOwned`.
This comes with some changes. Read below. We recommend to directly use the
implementations instead of the traits.

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

0 comments on commit 7d9c1e3

Please sign in to comment.