Skip to content

Update Thread.md #1166

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

Merged
merged 4 commits into from
Nov 15, 2019
Merged

Update Thread.md #1166

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad3a775
Update Thread.md
Nov 8, 2019
9080c48
Move content in Thread.md
Nov 11, 2019
3e78b7d
Add a tip to Thread.md
Nov 12, 2019
2a9e32c
Update phrasing in Thread.md
Nov 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api/rtos/Thread.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The Thread class allows defining, creating and controlling parallel tasks.

All the internal thread data structures are part of the C++ class, but by default, the thread stack is allocated on the heap. Memory is allocated at the run time during the call to `start` method. If you don't want to use dynamic memory, you can provide your own static memory using the constructor parameters.

The main thread stack size is specified as `rtos.main-thread-stack-size` in the configuration .json file. That defines the main thread for `mbed_rtos_start` in `mbed_rtos_rtx.c`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct, but I think this needs to be the third paragraph. The paragraphs above and below are talking about extra threads you create using the Thread API, but this paragraph is a side point about the memory for the starting main thread (which is not created using Thread).

Possibly it should be a "Note", like in the section above.


The default stack size is 4K. However, the application can override it by using the configuration system and setting the `THREAD_STACK_SIZE` option to the required size in `mbed_app.json`. For details, please see the [configuration documentation](../../reference/configuration/configuration.md).

## Thread class reference
Expand Down