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.

Sign up for GitHub

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

Jump to bottom

docs: porting: add new platform checklist #2014

Merged
merged 2 commits into from
Jul 17, 2020
Merged

docs: porting: add new platform checklist #2014

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a5f45d
docs: porting: add new platform checklist
bradjc Jul 13, 2020
17f503e
Update doc/Porting.md
bradjc Jul 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 13 additions & 1 deletion doc/Porting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,16 @@ of a board that is merged into the main Tock repository:
and help test the platform for future releases.

With these requirements met we should be able to merge the platform into Tock
relatively quickly.
relatively quickly. In the pull request to add the platform, you should add this
checklist:

```md
### New Platform Checklist

- [ ] Hardware is widely available.
Copy link
Member

Choose a reason for hiding this comment

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

And a link to acquire the hardware is available in the board README (?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We could certainly go into a lot more detail about what we expect: links, rust doc headers, no unwrap, etc., but maybe that gets a little clunky for a PR checklist?

- [ ] I can support the platform, at least initially.
bradjc marked this conversation as resolved.
Show resolved Hide resolved
- Basic features are implemented:
- [ ] `Console`, including `debug!()` and userspace `printf()`.
- [ ] Timers.
- [ ] GPIO with interrupts.
```