doc: streamline changelog

Author: phip1611

Diff for: uefi/CHANGELOG.md

@@ -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};
@@ -60,7 +64,7 @@
 - `Mode` is now `Copy` and `Clone`.
 - Added `TryFrom<&[u8]>` for `Time`.
 
-## Changed
+## Changed (**BREAKING**)
 - `SystemTable::exit_boot_services` is now `unsafe`. See that method's
   documentation for details of obligations for callers.
 - `BootServices::allocate_pool` now returns `NonZero<u8>` instead of
@@ -104,7 +108,7 @@
 - Added `MemoryMap::from_raw`.
 - Implemented `Hash` for all char and string types.
 
-## Changed
+## Changed (**BREAKING**)
 - `DevicePath::to_string` and `DevicePathNode::to_string` now return
   out-of-memory errors as part of the error type rather than with an `Option`.
 
@@ -115,7 +119,7 @@
 - Implemented `Index`, `IndexMut`, `get`, and `get_mut` on `MemoryMap`.
 - Added `SystemTable::as_ptr`.
 
-## Changed
+## Changed (**BREAKING**)
 - We fixed a memory leak in `GraphicsOutput::query_mode`. As a consequence, we
   had to add `&BootServices` as additional parameter.
 - `BootServices::free_pages` and `BootServices::free_pool` are now `unsafe` to
@@ -131,7 +135,7 @@
 
 # uefi - 0.25.0 (2023-10-10)
 
-## Changed
+## Changed (**BREAKING**)
 - MSRV bumped to 1.70.
 - `Input::wait_for_key_event` now returns an `Option<Event>`, and is no longer `const`.
 - `Protocol::wait_for_input_event` now returns an `Option<Event>`, and is no longer `const`.
@@ -166,15 +170,15 @@
   potentially-null interfaces without panicking.
 - `DevicePath::to_string` and `DevicePathNode::to_string`
 
-## Changed
+## Changed (**BREAKING**)
 - Renamed `LoadImageSource::FromFilePath` to `LoadImageSource::FromDevicePath`
 - The `Deref` and `DerefMut` impls for `ScopedProtocol` will now panic if the
   interface pointer is null.
 
 
 # uefi - 0.23.0 (2023-06-04)
 
-## Changed
+## Changed (**BREAKING**)
 - Fixed function signature bug in `BootServices::install_configuration_table`.
 
 
@@ -183,7 +187,7 @@
 ## Added
 - Added `BootServices::install_configuration_table`.
 
-## Changed
+## Changed (**BREAKING**)
 - Renamed `FileSystemIOErrorContext` to `IoErrorContext`.
 - `ResetType` is now a newtype-enum instead of a Rust enum. Its members now have
   upper-case names.
@@ -227,7 +231,7 @@
   - `MemoryType::BOOT_SERVICES_DATA` for UEFI boot drivers
   - `MemoryType::RUNTIME_SERVICES_DATA` for UEFI runtime drivers
 
-## Changed
+## Changed (**BREAKING**)
 - The `global_allocator` module has been renamed to `allocator`, and is now
   available regardless of whether the `global_allocator` feature is enabled. The
   `global_allocator` feature now only controls whether `allocator::Allocator` is
@@ -273,7 +277,7 @@ Rust 1.68 or higher.
   is no sensible way of presenting a useful Debug representation, such as for
   Unions.
 
-## Changed
+## Changed (**BREAKING**)
 - `SystemTable::exit_boot_services` now takes no parameters and handles
   the memory map allocation itself. Errors are now treated as
   unrecoverable and will cause the system to reset.
@@ -300,7 +304,7 @@ Rust 1.68 or higher.
 ## Added
 - Added `table::boot::PAGE_SIZE` constant.
 
-## Changed
+## Changed (**BREAKING**)
 - Fixed several protocol functions so that they work with unsized protocols
   (like `DevicePath`): `BootServices::locate_device_path`,
   `BootServices::get_handle_for_protocol`, `BootServices::test_protocol`,
@@ -324,7 +328,7 @@ Rust 1.68 or higher.
   integration with error-handling crates. (requires the **unstable** feature)
 - Added partial support for the TCG protocols for TPM devices under `uefi::proto::tcg`.
 
-## Changed
+## Changed (**BREAKING**)
 - `UnalignedSlice` now implements `Clone`, and the `Debug` impl now
   prints the elements instead of the internal fields.
 - The unstable `negative_impls` feature is no longer required to use this library.
@@ -363,7 +367,7 @@ Rust 1.68 or higher.
 - Added `BootServices::register_protocol_notify`.
 - Added `SearchType::ByRegisterNotify`and `ProtocolSearchKey`.
 
-## Changed
+## Changed (**BREAKING**)
 - Renamed crate feature `alloc` to `global_allocator`.
 - Renamed crate feature `exts` to `alloc`.
 - Fixed the definition of `AllocateType` so that `MaxAddress` and
@@ -424,7 +428,7 @@ Rust 1.68 or higher.
 - The `File` trait now knows the methods `is_regular_file` and `is_directory`.
   Developers profit from this on the struct `FileHandle`, for example.
 
-## Changed
+## Changed (**BREAKING**)
 - Marked `BootServices::handle_protocol` as `unsafe`. (This method is
   also deprecated -- use `open_protocol_exclusive` or `open_protocol` instead.)
 - Deprecated `BootServices::locate_protocol` and marked it `unsafe`. Use
@@ -461,7 +465,7 @@ Rust 1.68 or higher.
 - Fixed an incorrect pointer cast in the `Rng` protocol that could cause
   undefined behavior.
 
-## Changed
+## Changed (**BREAKING**)
 - Relaxed the version requirements for the `bitflags` and `log`
   dependencies to allow earlier patch versions.
 - Enabled `doc_auto_cfg` on docs.rs to show badges on items that are
@@ -484,7 +488,7 @@ Rust 1.68 or higher.
 - Included `cstr8` and `cstr16` macros from `uefi-macros` in the prelude.
 - Added `DevicePathInstance`, `DevicePathNode`, and `FfiDevicePath`.
 
-## Changed
+## Changed (**BREAKING**)
 - `Time::new` now takes a single `TimeParams` argument so that date and
   time fields can be explicitly named at the call site.
 - The file info types now derive `PartialEq` and `Eq`.
@@ -523,7 +527,7 @@ Rust 1.68 or higher.
 - Added `Output::output_string_lossy`.
 - Added `ResultExt::handle_warning`.
 
-## Changed
+## Changed (**BREAKING**)
 - Updated to the 2021 edition.
 - `File::open` now takes the filename as `&CStr16` instead of `&str`,
   avoiding an implicit string conversion.