documentation: selected topics

[OlegHahm]

• [x] Create an application (#4477)
  • [x] The main() function
  • [x] Include modules -> @OlegHahm
• [ ] Networking
  • [x] GNRC (https://github.com/RIOT-OS/RIOT/pull/4415)
  • [x] netdev2 -> @kaspar030
  • [x] conn (#4652)
• [ ] Makesystem (Sub Issue https://github.com/RIOT-OS/RIOT/issues/8420)
• [ ] Threading
  • [ ] scheduler
  • [ ] Choose the right stack size -> @OlegHahm
• [x] IPC (https://github.com/RIOT-OS/RIOT/pull/4475)
• [ ] Auto initialization
• [ ] interrupts
• [x] porting guide (+ periph API ?) -> @haukepetersen
• [x] driver model -> @haukepetersen
• [x] packages (https://github.com/RIOT-OS/RIOT/pull/4289)
• [x] xtimers

Topics based on questions on devel and users mailing list

• [ ] radio/netdev support for discovery boards, arduino boards etc.
• [x] creating a module (including doc about MODULE_.* macro) (https://github.com/RIOT-OS/RIOT/pull/4480)
• [ ] pseudo modules
  • [x] how do they work? (https://github.com/RIOT-OS/RIOT/pull/4480)
  • [ ] documentation on existing ones.
• [ ] How to deactivate features
• more in-depth API doc in general

[emmanuelsearch]

Memo: extract of email received:

I have not found a good documentation on ISR and Scheduler for RIOT.
I need to get a bit deeper to understand if ISR is executed in current task context and checking if task switch is required.
Appreciate if you could point me to a good document.

[miri64]

Structured the points a bit.

[OlegHahm]

What about xtimers? I guess that's another important module that needs some high-level description.

[miri64]

Yapp. Feel free to add ;-)

[cgundogan]

This issue does not seem to reflect the current state of documentational work done. What's the purpose of keeping this issue open?

[miri64]

Update it if its not up-to-date. I still think the doc needs a lot of work ;-)

[haukepetersen]

Yep. I am still heavily working on doc for cpu/boards/drivers.

[Lotterleben]

Dumb question: What's the criteria for 'selected'? :)

[OlegHahm]

That someone(TM) selected them. (scnr) More seriously: we tried to identified the most important high level concepts a RIOT newcomer needs to grasp.

[miri64]

There is some overlap to https://github.com/RIOT-OS/RIOT/issues/1837. Can we somehow merge them?

[stale[bot]]

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.

[maribu]

I like the idea of a tracking issue on improving doc. I think we still have areas left that could need a lot of improvement.

I think that the tracking issue here however is a bit outdated with some areas (xtimer, conn) no longer being relevant.