core: msg: update detail section on IPC by miri64 · Pull Request #4475 · RIOT-OS/RIOT

miri64 · 2015-12-14T16:16:23Z

Merges IPC section of old doxygen mainpage and detailed description and enhances it with some introductory text and examples.

Since I have uncrustify run as a pre-commit hook I included some style fixes too in an extra commit.

miri64 · 2015-12-14T16:23:54Z

Arch users be advices that there is a bug in the most current doxygen version regarding the fenced code block syntax: https://bugzilla.gnome.org/show_bug.cgi?id=759177

kaspar030 · 2015-12-14T16:34:06Z

core/include/msg.h

kaspar030 · 2015-12-14T16:39:16Z

thx for taking the time to create examples!

miri64 · 2015-12-14T16:47:52Z

What example would I set if I would not give examples ;P

miri64 · 2015-12-14T20:20:45Z

addressed comments

kaspar030 · 2015-12-14T20:50:04Z

core/include/msg.h

"In this case, ..."

kaspar030 · 2015-12-14T20:53:51Z

minor comments, but from my side, you can squash.

miri64 · 2015-12-14T21:30:27Z

Addressed comments and squashed immediately.

miri64 · 2015-12-14T22:01:58Z

Does this need to ACKs due to it [edit]technically[/edit] being a core change?

kaspar030 · 2015-12-14T22:30:37Z

nah. The two line code change doesn't chang anything semantically, so one ACK is OK.

kaspar030 · 2015-12-14T22:33:59Z

core/include/msg.h

kaspar030 · 2015-12-14T22:35:36Z

found two more typos... fix if you feel like... IMHO we should skip travis on this (all but the static tests that check the docs).

PeterKietzmann · 2015-12-15T07:54:27Z

core/include/msg.h

response response

PeterKietzmann · 2015-12-15T08:04:29Z

core/include/msg.h

How about "Timing & messages"?

PeterKietzmann · 2015-12-15T08:06:30Z

Thanks Martine for taking the initiative! No need to discuss on my proposed changes, adapt what you take as reasonable.

miri64 · 2015-12-15T10:08:57Z

Addressed last batch of comments.

PeterKietzmann · 2015-12-15T10:36:44Z

core/include/msg.h

"for" too much I guess

PeterKietzmann · 2015-12-15T10:38:47Z

@authmillenon sorry being so picky, but now that you're on it ;-) ! IMO it's fine to squash

miri64 · 2015-12-15T10:47:00Z

Addressed comments and squashed

PeterKietzmann · 2015-12-15T10:54:04Z

ACK from my side. @kaspar030 please have a look and merge then!!!

OlegHahm · 2015-12-15T15:20:17Z

core/include/msg.h

Why did you remove these parens?

It's in the piggybacked uncrustify commit.

I guess we have to fix some settings there.

It's one expression, so as far as I understand your parenthesis rules this should be right...

(for e.g. two expressions the parenthesis would be kept around each)

"My" rule is basically always to have parens around any condition. Especially, I don't see any reason to remove them.

IMO ignore sounds good.

Changed and squashed immediately.

miri64 · 2015-12-16T21:36:21Z

I'm confused. @PeterKietzmann did you ACK or do you want @kaspar030 to ACK?

kaspar030 · 2015-12-16T22:00:12Z

IMHO its fine. Go!

core: msg: update detail section on IPC

miri64 · 2015-12-16T23:02:30Z

Release version in #4496

miri64 added Area: doc Area: Documentation Area: core Area: RIOT kernel. Handle PRs marked with this with care! DocTF labels Dec 14, 2015

miri64 assigned OlegHahm Dec 14, 2015

miri64 added this to the Release 2015.12 milestone Dec 14, 2015

OlegHahm mentioned this pull request Dec 14, 2015

documentation: selected topics #4309

Open

24 tasks

kaspar030 reviewed Dec 14, 2015
View reviewed changes

core/include/msg.h Outdated

Copy link
Copy Markdown

Contributor

kaspar030 Dec 14, 2015

Choose a reason for hiding this comment

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

must must

kaspar030 reviewed Dec 14, 2015
View reviewed changes

core/include/msg.h Outdated

Copy link
Copy Markdown

Contributor

kaspar030 Dec 14, 2015

Choose a reason for hiding this comment

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

"In this case, ..."

miri64 force-pushed the doc/enh/msg branch from 79120ef to 0b12c59 Compare December 14, 2015 21:30

miri64 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Dec 14, 2015

miri64 force-pushed the doc/enh/msg branch from 0b12c59 to 2d2d916 Compare December 14, 2015 21:49

kaspar030 reviewed Dec 14, 2015
View reviewed changes

core/include/msg.h Outdated

Copy link
Copy Markdown

Contributor

kaspar030 Dec 14, 2015

Choose a reason for hiding this comment

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

"is sent"

PeterKietzmann reviewed Dec 15, 2015
View reviewed changes

core/include/msg.h Outdated

Copy link
Copy Markdown

Member

PeterKietzmann Dec 15, 2015

Choose a reason for hiding this comment

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

response response

PeterKietzmann reviewed Dec 15, 2015
View reviewed changes

core/include/msg.h Outdated

Copy link
Copy Markdown

Member

PeterKietzmann Dec 15, 2015

Choose a reason for hiding this comment

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

How about "Timing & messages"?

PeterKietzmann reviewed Dec 15, 2015
View reviewed changes

core/include/msg.h Outdated

Copy link
Copy Markdown

Member

PeterKietzmann Dec 15, 2015

Choose a reason for hiding this comment

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

"for" too much I guess

core: msg: update detail section on IPC

512448b

miri64 force-pushed the doc/enh/msg branch from 5b2f7d8 to eb31f84 Compare December 15, 2015 10:46

OlegHahm reviewed Dec 15, 2015
View reviewed changes

core: msg: piggy-back some style fixes by uncrustify

49167a4

miri64 force-pushed the doc/enh/msg branch from eb31f84 to 49167a4 Compare December 15, 2015 16:10

miri64 mentioned this pull request Dec 15, 2015

uncrustify: ignore parens on return #4481

Merged

kaspar030 added a commit that referenced this pull request Dec 16, 2015

Merge pull request #4475 from authmillenon/doc/enh/msg

1d22374

core: msg: update detail section on IPC

kaspar030 merged commit 1d22374 into RIOT-OS:master Dec 16, 2015

miri64 mentioned this pull request Dec 16, 2015

core: msg: update detail section on IPC (2015.12 version) #4496

Merged

miri64 deleted the doc/enh/msg branch December 16, 2015 23:02

LudwigKnuepfer mentioned this pull request Oct 14, 2016

reference/core: primers missing #1837

Closed

8 tasks

Conversation

miri64 commented Dec 14, 2015

Uh oh!

miri64 commented Dec 14, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaspar030 commented Dec 14, 2015

Uh oh!

miri64 commented Dec 14, 2015 via email

Uh oh!

miri64 commented Dec 14, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaspar030 commented Dec 14, 2015

Uh oh!

miri64 commented Dec 14, 2015

Uh oh!

miri64 commented Dec 14, 2015

Uh oh!

kaspar030 commented Dec 14, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaspar030 commented Dec 14, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PeterKietzmann commented Dec 15, 2015

Uh oh!

miri64 commented Dec 15, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PeterKietzmann commented Dec 15, 2015

Uh oh!

miri64 commented Dec 15, 2015

Uh oh!

PeterKietzmann commented Dec 15, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miri64 commented Dec 16, 2015

Uh oh!

kaspar030 commented Dec 16, 2015

Uh oh!

miri64 commented Dec 16, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants