Skip to content

Conversation

crasbe
Copy link
Contributor

@crasbe crasbe commented Jul 12, 2025

Contribution description

During the review of #21573 the AVaRICE debugger came up and our documentation is a bit out of date.
While the development of AVaRICE is still slow, it is not stopped (anymore) and there was a release in 2020. When the documentation was written, there hasn't been a release for nearly a decade, so I decided to remove the remarks about AVaRICE's ancient code base.

RFC: It would be possible to add a remark that AVaRICE should probably still be built from code instead of using the release version, as half a decade is also quite old already...

While touching the files, I moved them to Markdown format as discussed in #21220.

It would be nice to have a single documentation for AVaRICE, because currently it's a bit redundant with varying levels of completeness, but I didn't feel like diving into another rabbit hole today, sorry 😅

Testing procedure

Check that the documentation still looks good.

Issues/PRs references

This came up in #21573.

@crasbe crasbe requested a review from maribu July 12, 2025 12:48
@crasbe crasbe requested a review from jia200x as a code owner July 12, 2025 12:48
@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / 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 labels Jul 12, 2025
@github-actions github-actions bot added Area: doc Area: Documentation Area: boards Area: Board ports labels Jul 12, 2025
@crasbe crasbe changed the title Pr/avarice update boards/*avr*: Update the link to the AVaRICE documentation Jul 12, 2025
@riot-ci
Copy link

riot-ci commented Jul 12, 2025

Murdock results

✔️ PASSED

4fbd535 boards/avr: update link for AVaRICE

Success Failures Total Runtime
1 0 1 01m:16s

Artifacts

@maribu maribu enabled auto-merge July 12, 2025 14:05
@maribu maribu added this pull request to the merge queue Jul 12, 2025
Merged via the queue into RIOT-OS:master with commit ef168df Jul 12, 2025
30 checks passed
@Teufelchen1 Teufelchen1 added this to the Release 2025.07 milestone Jul 14, 2025
@crasbe crasbe deleted the pr/avarice_update branch July 30, 2025 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: boards Area: Board ports 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 Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants