-
Notifications
You must be signed in to change notification settings - Fork 107
rfcs: add move_itm_crate #589
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b5611fa
rfcs: add move_itm_crate
tmplt 238c90f
Replace Cortex-M Working Group with Rust Embedded Working Group
jonathanpallant 130c1c2
move_itm_crate: spelling
tmplt 11e9321
move_itm_crate: simplify, amend
tmplt df468ce
move_itm_crate: add note to release an itm v0.4.0
tmplt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
- Feature Name: move_itm_crate | ||
- Start Date: 2021-12-01 | ||
- RFC PR: (leave this empty) | ||
- Rust Issue: (leave this empty) | ||
|
||
# Summary | ||
[summary]: #summary | ||
|
||
Disown from the Rust-Embedded Working Group (henceforth referred to as the "WG") and move the [`itm`](https://github.com/rust-embedded/itm) repo and [crates.io registery entry](https://crates.io/crates/itm) to @tmplt. | ||
|
||
# Motivation | ||
[motivation]: #motivation | ||
|
||
The `itm` crate has been effectively superseeded by [`itm-decode`](https://crates.io/crates/itm-decode), specifially the [`rtic-scope:master`](https://github.com/rust-embedded/itm/pull/41) fork. | ||
This fork offers, in addition to the functionality of the `itm` crate, an `Iterator`-based design, more granular error enums, synchronization packet support, and timestamp generation of trace packets. | ||
Planned future functionality at the time of writing is | ||
- arbitration of instrumentation and extension packets such that payloads written on the target device via `cortex_m::iprint("message/payload")` can be trivially decodede by the library end-user; and | ||
- an asynchronous API. | ||
|
||
This fork also offers an `itm-decode` CLI tool that replaces `itmdump`. | ||
|
||
The pull-request replacing `itm` with the fork under the umbrella of the WG was discussed during [yesterday's (2021-11-31) Matrix chat meeting](https://matrix.to/#/!BHcierreUuwCMxVqOf:matrix.org/$OcmpjhKy4iOk_5uQyhUpfVDA5_MtnNc1PkHVUDodSc8?via=matrix.org&via=psion.agg.io&via=beeper.com). | ||
Merging this pull-request would require the WG to support a new code base and vet any future changes to its implementation and API. | ||
As the library has yet to stabilize rapid changes can thus be expected which may cause release friction due to the vetting required by at least one WG member that is not proposing the changes themselves. | ||
Questions whether host-side ITM software should be handled under the WG also arose. | ||
A consensus regarding the merge was not reached. | ||
|
||
An inbetween approach is thus proposed: | ||
disown from the WG and move ownership of the `itm` repo and crate to @tmplt such that development can continue without friction, and so that there is one canonical ITM decoding crate to avoid end-user confusion. | ||
After the pull-request discussed above have been merged and the crate has stabilized discussion on whether to adopt the crate into the WG again can resume. | ||
The crate is unlikely to stabilize before Q1 2022. | ||
|
||
# Unresolved questions | ||
[unresolved]: #unresolved-questions | ||
|
||
Whether the `itm` crate should ultimately be maintained by the WG. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.