Skip to content

Commit bf8fa45

Browse files
committed
Update changelog
1 parent c3d09ec commit bf8fa45

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/docs/changelog/unreleased.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# Unreleased
22

3+
## 🚨 Breaking Changes
4+
5+
### Update of crc configurations
6+
- **Rename:** The `Crc16.CCITT` configuration to `Crc16.XMODEM`.
7+
- **New Addition:** Introduced `Crc16.KERMIT`, which matches the official configuration for `Crc16.CCITT`.
8+
9+
#### Decision Rationale
10+
It was intentionally decided not to reintroduce `Crc16.CCITT` with the updated configuration. While it could have been added as an alias for `Crc16.KERMIT` or a replacement, omitting `Crc16.CCITT` ensures that client code will break upon update, thereby forcing maintainers to take notice and react accordingly.
11+
12+
#### Migration Guide
13+
Below are solutions to the two common scenarios that need to be addressed due to this change:
14+
15+
1. **If you previously used `Crc16.CCITT` and expected the configuration defined [here](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.cat.crc-16-kermit):**
16+
17+
**Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.KERMIT`.
18+
19+
2. **If you depended on or wanted to use the configuration values that `Crc16.CCITT` provided so far:**
20+
21+
**Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.XMODEM`.
22+
23+
#### Related Issues
24+
- [#148](https://github.com/Nicoretti/crc/issues/148)
25+
- [#145](https://github.com/Nicoretti/crc/issues/145)
26+
327
## 🔩 Internal
428
* Update `python-environment` action
529
* Add classifiers to `pyproject.toml`

0 commit comments

Comments
 (0)