-
Notifications
You must be signed in to change notification settings - Fork 570
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
framework/task_manager : Add README and modify the description in he… #1864
Conversation
Target : [a970745c31a3a4426650dc1321e581b446e06597] - Code Rule Check (C++) OK. |
Target : [a970745c31a3a4426650dc1321e581b446e06597] - Code Rule Check OK. |
* @param[in] permission the permission of task which request to register\n | ||
* Only builtin task can be managed by task manager. | ||
* @param[in] name the name of task which to be registered | ||
* @param[in] permission the permission of task which to be registered\n |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Above line does not have "\n" at end of line, but here it is. What is right?
framework/src/task_manager/README.md
Outdated
Further details are shown below. | ||
|
||
## API List | ||
[API List](https://github.com/Samsung/TizenRT/tree/master/framework/include/task_manager) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Find APIs' details on header file, [task_manager.h](https://github.com/Samsung/TizenRT/tree/master/framework/include/task_manager/task_manager.h)
framework/src/task_manager/README.md
Outdated
[API List](https://github.com/Samsung/TizenRT/tree/master/framework/include/task_manager) | ||
|
||
## Task Manager Sample | ||
[Task Manager Sample](https://github.com/Samsung/TizenRT/tree/master/apps/examples/task_manager_sample) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Sample Application
[Task Manager Sample](https://github.com/Samsung/TizenRT/tree/master/apps/examples/task_manager_sample) covers all of above mentioned functionality. Please find sample's details on [README](....../README.md).
framework/src/task_manager/README.md
Outdated
|
||
Please find details in [here](#api-list). | ||
|
||
## How to enable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Prerequisites
framework/src/task_manager/README.md
Outdated
|
||
Task manager manages the registered applications. | ||
Supported features and APIs are shown below: | ||
1. application registration APIs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about below?
Features | Functions |
---|---|
Regitration | task_manger_register() |
task_manager_unregister() | |
------------ | ------------------------------- |
Please find https://github.com/Samsung/TizenRT/edit/master/apps/system/utils/README.md
@@ -116,8 +116,9 @@ typedef struct task_info_list_s task_info_list_t; | |||
/** | |||
* @brief Request to register a task | |||
* @details @b #include <task_manager/task_manager.h> | |||
* @param[in] name the name of task which request to register | |||
* @param[in] permission the permission of task which request to register\n | |||
* Only builtin task can be managed by task manager. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you leave a link of builtin feature?
Find apps/builtin/README.md to know how to use builtin task.
Target : [c31555aeb89c2b6b7f81f5e763159e8c191e159f] - Code Rule Check OK. |
Target : [c31555aeb89c2b6b7f81f5e763159e8c191e159f] - Code Rule Check (C++) OK. |
dc483f3
to
8c4a08d
Compare
Target : [dc483f3e6fc98824e1289cc24ab9ce62c419eea2] - |
1 similar comment
Target : [dc483f3e6fc98824e1289cc24ab9ce62c419eea2] - |
Target : [8c4a08df58d7580577dd10a0ba31c89b5f61e899] - Code Rule Check OK. |
Target : [8c4a08df58d7580577dd10a0ba31c89b5f61e899] - Code Rule Check (C++) OK. |
cfd12b7
to
e2fb86d
Compare
Target : [cfd12b72d28cf0bae26f95c3bd8a2e2c3c563414] - |
1 similar comment
Target : [cfd12b72d28cf0bae26f95c3bd8a2e2c3c563414] - |
Target : [e2fb86d850d9943b67eab73a8801798f31476fbf] - |
1 similar comment
Target : [e2fb86d850d9943b67eab73a8801798f31476fbf] - |
Target : [0de0d07a137079af6021ae9f129c079aa5f3f8ab] - Code Rule Check (C++) OK. |
Target : [0de0d07a137079af6021ae9f129c079aa5f3f8ab] - Code Rule Check OK. |
ed05831
to
5b25be2
Compare
It looks good |
Target : [ed05831893730b769f6b1b9bb13851ec9aa2d58c] - |
1 similar comment
Target : [ed05831893730b769f6b1b9bb13851ec9aa2d58c] - |
Target : [5b25be27d9e42903b32000ab1c433bb409c6751f] - Code Rule Check (C++) OK. |
Target : [5b25be27d9e42903b32000ab1c433bb409c6751f] - Code Rule Check OK. |
Target : [611858650ed9ff31b04355b2cd96932eee0b438f] - Code Rule Check OK. |
framework/src/task_manager/README.md
Outdated
|
||
### State | ||
Each Application can have four states. | ||
![State Diagram](media/tm_state_diagram.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
![State Diagram](https://github.com/Samsung/TizenRT/tree/master/docs/media/tm_state_diagram.png)
framework/src/task_manager/README.md
Outdated
- TM_TASK_PERMISSION_DEDICATE : Only a task which requested to register that task can request the control to Task Manager | ||
|
||
### State | ||
Each Application can have four states. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Task Manager manages each application with four states, unregistered, stop, running and paused.
Please find below how to move each state by APIs.
framework/src/task_manager/README.md
Outdated
: Bixby can start the Alarm application through the task manager. | ||
: When Wi-Fi disconnection message is broadcasted, applications can receive the broadcast message. | ||
|
||
## Features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Details
framework/src/task_manager/README.md
Outdated
Builtin information should follow the [format](https://github.com/Samsung/TizenRT/tree/master/apps/builtin). | ||
|
||
|
||
Further details are shown below. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove this line
Target : [69f3234d1dbaae9346abb90d12137024ba1157da] - Code Rule Check (C++) OK. |
Target : [69f3234d1dbaae9346abb90d12137024ba1157da] - Code Rule Check OK. |
Target : [bd8faf797af17b75a953ab48628960001ebeb873] - Code Rule Check OK. |
Target : [bd8faf797af17b75a953ab48628960001ebeb873] - Code Rule Check (C++) OK. |
775cc88
to
8802883
Compare
Target : [880288370e8fb7d272c3d012393588c590813f2a] - Code Rule Check OK. |
Target : [880288370e8fb7d272c3d012393588c590813f2a] - Code Rule Check (C++) OK. |
5780669
to
5d19f8f
Compare
Target : [7273669bcf4bc0d43563c23d4714c1e4808c465c] - |
1 similar comment
Target : [7273669bcf4bc0d43563c23d4714c1e4808c465c] - |
Target : [5d19f8f52c017aeefcd8e86dd29ecdba9cc7250e] - Code Rule Check (C++) OK. |
Target : [5d19f8f52c017aeefcd8e86dd29ecdba9cc7250e] - Code Rule Check OK. |
framework/src/task_manager/README.md
Outdated
|
||
|
||
## Sample Application | ||
[Task Manager Sample](https://github.com/Samsung/TizenRT/tree/master/apps/examples/task_manager_sample) covers all of above mentioned functionality. Please find sample's details on [README](....../README.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README link is not working.
Target : [ac952e19c85daffc143d44e0d56fc8cf2d69299e] - Code Rule Check (C++) OK. |
Target : [ac952e19c85daffc143d44e0d56fc8cf2d69299e] - Code Rule Check OK. |
…der file 1. Add basic description in README.md 2. Modify wrong expression and add description in task_manager.h
Target : [3584c45] - Code Rule Check OK. |
Target : [3584c45] - Code Rule Check (C++) OK. |
…ader file