CHANGELOG.md (fae3641d95371a4cb089b413ef87708afffbdbac) CHANGELOG.md (e7f55113922cbde6fea1cc8b0b1548e55b0982d9)
1# Changelog
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6and this project adheres to
7[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8

--- 21 unchanged lines hidden (view full) ---

30### Changed
31
321. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs
332. platform: Rework decode/encode_pldm_message_poll_event_data() APIs
343. platform: Stabilise decode_pldm_message_poll_event_data() APIs
35
36### Deprecated
37
1# Changelog
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6and this project adheres to
7[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8

--- 21 unchanged lines hidden (view full) ---

30### Changed
31
321. pdr: Stabilise related decode_entity_auxiliary_names_pdr() APIs
332. platform: Rework decode/encode_pldm_message_poll_event_data() APIs
343. platform: Stabilise decode_pldm_message_poll_event_data() APIs
35
36### Deprecated
37
381. fru: Deprecate `get_fru_record_by_option_check()`
381. Rename and deprecate functions with the `_check` suffix
39
39
40 Users should switch to `get_fru_record_by_option()`. Migration can be
41 performed using the `apply-renames` script and the [clang-rename][]
42 configuration under `evolutions/`:
40 All library function return values always need to be checked. The `_check`
41 suffix is redundant, so remove it. Migration to the non-deprecated
42 equivalents without the `_check` suffix can be performed using
43 `scripts/ apply-renames` and the [clang-rename][] configurations under
44 `evolutions/`
43
45
44 ```
45 $ ./scripts/apply-renames evolutions/current/get_fru_record_by_option_check.yaml
46 ```
46 The deprecated functions:
47
47
48 - `get_fru_record_by_option_check()`
49 - `pldm_pdr_add_check()`
50 - `pldm_pdr_add_fru_record_set_check()`
51
48[clang-rename]: https://clang.llvm.org/extra/clang-rename.html
49
52[clang-rename]: https://clang.llvm.org/extra/clang-rename.html
53
502. dsp: pdr: Rename pldm_pdr_add_check()
51
52 Users should switch to `pldm_pdr_add()`. Migration can be automated with
53 `evolutions/current/pldm_pdr_add_check.yaml`.
54
55### Removed
56
571. IBM OEM header compatibility symlinks.
58
59 Anyone left using the deprecated paths can migrate using the coccinelle patch
60 at `evolutions/current/oem-ibm-header-compat.cocci`.
61
62### Fixed

--- 389 unchanged lines hidden --- 		54### Removed
55
561. IBM OEM header compatibility symlinks.
57
58 Anyone left using the deprecated paths can migrate using the coccinelle patch
59 at `evolutions/current/oem-ibm-header-compat.cocci`.
60
61### Fixed

--- 389 unchanged lines hidden ---