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

improve real-time documentation, find coding conventions #4872

Closed
kaspar030 opened this issue Feb 21, 2016 · 7 comments
Closed

improve real-time documentation, find coding conventions #4872

kaspar030 opened this issue Feb 21, 2016 · 7 comments
Assignees
Labels
Area: doc Area: Documentation Discussion: RFC The issue/PR is used as a discussion starting point about the item of the issue/PR State: stale State: The issue / PR has no activity for >185 days

Comments

@kaspar030
Copy link
Contributor

While it is certainly possible to create real-time applications with RIOT, depending on the definition and requirements, actual documentation and coding conventions are lacking.

We should come up with

a) conventions like "disabling IRQ's for less than N instructions is tolerable" (example)
b) document side effects caused by a)
c) document algorithmic implications on real-time requirements (e.g., "locking a mutex might traverse the list of currently locked threads")

...

@kaspar030 kaspar030 added Area: doc Area: Documentation Discussion: RFC The issue/PR is used as a discussion starting point about the item of the issue/PR labels Feb 21, 2016
@LudwigKnuepfer
Copy link
Member

Maybe it's more purposeful to provide some tool for the task of identifying the possible side-effects anyways.

@kaspar030
Copy link
Contributor Author

Maybe it's more purposeful to provide some tool for the task of identifying the possible side-effects anyways.

Interesting. You mean e.g., a static code analyzer beefed up to count critical section cycles?

@LudwigKnuepfer
Copy link
Member

Something like that, yes.

@kYc0o
Copy link
Contributor

kYc0o commented Jul 11, 2016

any news on this? There's no milestone but a current issue is referencing this one, so maybe we need to put a milestone on this too.

@LudwigKnuepfer
Copy link
Member

Do as you please.

@miri64 miri64 added the DocTF label Oct 18, 2016
@aabadie aabadie removed the DocTF label Oct 13, 2017
@stale
Copy link

stale bot commented Aug 10, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you want me to ignore this issue, please mark it with the "State: don't stale" label. Thank you for your contributions.

@stale stale bot added the State: stale State: The issue / PR has no activity for >185 days label Aug 10, 2019
@kaspar030
Copy link
Contributor Author

Not much discussion here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation Discussion: RFC The issue/PR is used as a discussion starting point about the item of the issue/PR State: stale State: The issue / PR has no activity for >185 days
Projects
None yet
Development

No branches or pull requests

5 participants