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

doc: make the 2^x requirement for msg_queue more visible #6003

Merged
merged 1 commit into from
Nov 1, 2016
Merged

doc: make the 2^x requirement for msg_queue more visible #6003

merged 1 commit into from
Nov 1, 2016

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Oct 27, 2016

@miri64 miri64 added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation DocTF labels Oct 27, 2016
@miri64 miri64 added this to the Release 2016.10 milestone Oct 27, 2016
OlegHahm
OlegHahm reviewed Oct 27, 2016
View reviewed changes
core/include/msg.h
@@ -365,6 +365,8 @@ int msg_avail(void);
/**
* @brief Initialize the current thread's message queue.
*
* @pre @p num **must be a power of two**
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't we remove the second line of the parameter documentation, then?

Copy link
Member

Choose a reason for hiding this comment

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

And I would keep the upper case here.

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought maybe have it documented double might help, but sure upper case is always better.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@OlegHahm
Copy link
Member

I'm not sure that duplicating this information will help a lot in order to reduce the questions on the mailing list/issue tracker, because many people tend just not to read the documentation anyway. However, it is worth a try.

@Lotterleben
Copy link
Member

Well that sounds fatalistic :D

@miri64
Copy link
Member Author

miri64 commented Oct 27, 2016

I'm not sure that duplicating this information will help a lot in order to reduce the questions on the mailing list/issue tracker, because many people tend just not to read the documentation anyway. However, it is worth a try.

That's why I also added it to the boiler plate tutorials ;-)

@miri64 miri64 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Oct 31, 2016
@PeterKietzmann
Copy link
Member

This should go in today, right? Please squash your second commit

@miri64 miri64 force-pushed the core/doc/msg-init-queue-power-of-two branch from 78ec200 to f93ab1a Compare November 1, 2016 10:08
@miri64
Copy link
Member Author

miri64 commented Nov 1, 2016

Squashed.

PeterKietzmann
PeterKietzmann approved these changes Nov 1, 2016
View reviewed changes
Copy link
Member

@PeterKietzmann PeterKietzmann left a comment

Choose a reason for hiding this comment

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

Murdock failed unrelated. This is just documentation, no need to stress Murdock with that. ACK

@PeterKietzmann PeterKietzmann merged commit 11a8969 into RIOT-OS:master Nov 1, 2016
@miri64 miri64 deleted the core/doc/msg-init-queue-power-of-two branch November 1, 2016 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OlegHahm OlegHahm OlegHahm left review comments

@PeterKietzmann PeterKietzmann PeterKietzmann approved these changes

Assignees

@Lotterleben Lotterleben

@kaspar030 kaspar030

Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Milestone
Release 2016.10
Development

Successfully merging this pull request may close these issues.
5 participants
@miri64 @OlegHahm @Lotterleben @PeterKietzmann @kaspar030