Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release-notes.txt: add 2024.01 release notes #20350

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

MrKevinWeiss
Copy link
Contributor

Contribution description

It is that time again! Please add changes and comments as needed!

Testing procedure

Read it!

Issues/PRs references

@github-actions github-actions bot added the Area: doc Area: Documentation label Feb 7, 2024
release-notes.txt Outdated Show resolved Hide resolved
@MrKevinWeiss
Copy link
Contributor Author

ping @RIOT-OS/maintainers

release-notes.txt Outdated Show resolved Hide resolved
Copy link
Member

@maribu maribu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. To me, the most headline-contributions in the release (from most exciting to least exiting) are:

  • groundwork for 64 bit support --> expect support for native64 and maybe first RISC-V 64 bit boards in next release
  • support for power saving on all supported AVR boards
  • ZEP topology in examples/gnrc_border_router
  • API to query supported frequencies added to periph_timer

Packages
--------

* Bumb nanopb to 0.4.8 (#20132)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Bumb nanopb to 0.4.8 (#20132)
* Bump nanopb to 0.4.8 (#20132)

+ drivers/ws281x: Add gpio_ll and timer based driver (#19891)
+ pyterm: add native support (#20172)
+ sys/shell: add firmware version to version cmd (#20244)
* AVR-8: Implement Power Management (#19784)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be one of the bigger changes to highlight.

Comment on lines 122 to 129
+ cpu/atmega_common: implement periph_timer_query_freqs (#20142)
+ cpu/cc26xx_cc13xx: implement periph_timer_query_freqs (#20143)
+ cpu/kinetis: implement periph_timer_query_freqs (#20144)
+ cpu/nrf5x_common: implement periph_timer_query_freqs (#20145)
+ cpu/qn908x: implement periph_timer_query_freqs (#20146)
+ cpu/sam0_common: implement periph_timer_query_freqs (#20147)
+ cpu/stm32: add ADCAL operation (#20044)
+ cpu/stm32: implement periph_timer_query_freqs (#20148)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Theses periph_timer_query_freqs changes may also be something to highlight.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They're also something that could be grouped in the change log.

+ dist/testbed-support: Add openmote board (#19979)
+ dist/tools/riotboot_gen_hdr/genhdr: add update command (#20239)
* Bump version of UF2 package (#20035)
* examples/gnrc_border_router: enable setting ZEP topology (#20006)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not really my turf, but this also looks like a release highlight to me

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just a small patch that adds the convenience of selecting the topology file from the border router Makefile

Copy link
Contributor

@mguetschow mguetschow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM otherwise.


The 2024.01 release includes:

- May fixes to peripherals due to the periph testing shield
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- May fixes to peripherals due to the periph testing shield
- Many fixes to peripherals due to the periph testing shield


194 pull requests, composed of 475 commits, have been merged since the
last release, and 4 issues have been solved. 30 people contributed with
code in -1 days. 1083 files have been touched with 36196 (+) insertions and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
code in -1 days. 1083 files have been touched with 36196 (+) insertions and
code in xx? days. 1083 files have been touched with 36196 (+) insertions and

@chrysn
Copy link
Member

chrysn commented Feb 7, 2024

* groundwork for 64 bit support --> expect support for `native64` and maybe first RISC-V 64 bit boards in next release

That's noteworthy from an inside PoV, but for the audience of release notes (whose priorities are more "what can it do now that it couldn't before"), I think it is not relevant for a spotlight item in this release.

@MrKevinWeiss
Copy link
Contributor Author

OK. added the changes!

+ boards: add support for Adafruit Feather nRF52840 Sense (#20027)
+ drivers/include/periph: add FREQM peripheral driver (#20020)
+ drivers/ws281x: Add gpio_ll and timer based driver (#19891)
+ pyterm: add native support (#20172)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also a user-visible change

-----------

+ print: Added size_t print format specifier (#20194)
* drivers/mtd: use XFA for pointers to defined MTDs (#19465)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a breaking change that requires the user to adapt their code - the PR contains a short description of what migration steps need to be performed.

* cpu/nrf5x: clean up periph_uart (#20102)
* cpu/stm32: FMC used for low-level LCD parallel interface (#19943)
+ cpu/esp32/periph: add low-level SDMMC peripheral driver for ESP32 and
ESP32-S3 (#19786)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's also a big feature

Testing
-------

+ tests/periph/uart_locate_pins: new test/utility app (#20253)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a neat new tool


The 2024.01 release includes:

- Breaking change for board definition due to XFA for pointers to defined MTD
Copy link
Contributor

@benpicco benpicco Feb 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's be nice to our users and tell them what thy need to do to fix their boards:

To adapt boards definitions to the new API:

  • remove the MTD_NUMOF definition from board.h
  • add MTD_XFA_ADD(<mtd_dev>, <idx>); to the definition of <mtd_dev> (e.g. the mtd_spi_nor_t declaration).

For code that references MTD devices:

  • MTD_0, MTD_1, … defines are no longer needed. Use mtd_dev_get(0), mtd_dev_get(1), … instead.

test_configs.py Outdated Show resolved Hide resolved
@MrKevinWeiss MrKevinWeiss force-pushed the pr/releasenotes/202401 branch from abb11c2 to 3905e34 Compare February 7, 2024 13:50
@MrKevinWeiss MrKevinWeiss added CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Feb 7, 2024
@riot-ci
Copy link

riot-ci commented Feb 7, 2024

Murdock results

✔️ PASSED

8b1018a release-notes.txt: add 2024.01 release notes

Success Failures Total Runtime
1 0 1 55s

Artifacts

@MrKevinWeiss
Copy link
Contributor Author

Things seems stable now... Can a @RIOT-OS/maintainers give an ack?

release-notes.txt Outdated Show resolved Hide resolved
@MrKevinWeiss MrKevinWeiss force-pushed the pr/releasenotes/202401 branch from 3905e34 to 8b1018a Compare February 8, 2024 11:05
@MrKevinWeiss MrKevinWeiss added this pull request to the merge queue Feb 8, 2024
Merged via the queue into RIOT-OS:master with commit c0f233d Feb 8, 2024
28 checks passed
@MrKevinWeiss MrKevinWeiss deleted the pr/releasenotes/202401 branch February 8, 2024 13:26
@MrKevinWeiss MrKevinWeiss added this to the Release 2024.04 milestone Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants