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.

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

Merged
merged 1 commit into from
Jun 27, 2018

Conversation

jeongchanKim
Copy link
Contributor

…ader file

  1. Add basic description in README.md
  2. Modify wrong expression and add description in task_manager.h

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [a970745c31a3a4426650dc1321e581b446e06597] - Code Rule Check (C++) OK.

@seinfra
Copy link

seinfra commented Jun 14, 2018

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
Copy link
Contributor

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?

Further details are shown below.

## API List
[API List](https://github.com/Samsung/TizenRT/tree/master/framework/include/task_manager)
Copy link
Contributor

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)

[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)
Copy link
Contributor

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).


Please find details in [here](#api-list).

## How to enable
Copy link
Contributor

Choose a reason for hiding this comment

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

## Prerequisites


Task manager manages the registered applications.
Supported features and APIs are shown below:
1. application registration APIs
Copy link
Contributor

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.
Copy link
Contributor

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.

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [c31555aeb89c2b6b7f81f5e763159e8c191e159f] - Code Rule Check OK.

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [c31555aeb89c2b6b7f81f5e763159e8c191e159f] - Code Rule Check (C++) OK.

@jeongchanKim jeongchanKim force-pushed the tm_readme branch 2 times, most recently from dc483f3 to 8c4a08d Compare June 14, 2018 02:24
@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [dc483f3e6fc98824e1289cc24ab9ce62c419eea2] -

1 similar comment
@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [dc483f3e6fc98824e1289cc24ab9ce62c419eea2] -

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [8c4a08df58d7580577dd10a0ba31c89b5f61e899] - Code Rule Check OK.

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [8c4a08df58d7580577dd10a0ba31c89b5f61e899] - Code Rule Check (C++) OK.

@jeongchanKim jeongchanKim force-pushed the tm_readme branch 3 times, most recently from cfd12b7 to e2fb86d Compare June 14, 2018 04:35
@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [cfd12b72d28cf0bae26f95c3bd8a2e2c3c563414] -

1 similar comment
@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [cfd12b72d28cf0bae26f95c3bd8a2e2c3c563414] -

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [e2fb86d850d9943b67eab73a8801798f31476fbf] -

1 similar comment
@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [e2fb86d850d9943b67eab73a8801798f31476fbf] -

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [0de0d07a137079af6021ae9f129c079aa5f3f8ab] - Code Rule Check (C++) OK.

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [0de0d07a137079af6021ae9f129c079aa5f3f8ab] - Code Rule Check OK.

@jeongchanKim jeongchanKim force-pushed the tm_readme branch 2 times, most recently from ed05831 to 5b25be2 Compare June 14, 2018 04:55
@jeongarmy
Copy link
Contributor

It looks good

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [ed05831893730b769f6b1b9bb13851ec9aa2d58c] -

1 similar comment
@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [ed05831893730b769f6b1b9bb13851ec9aa2d58c] -

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [5b25be27d9e42903b32000ab1c433bb409c6751f] - Code Rule Check (C++) OK.

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [5b25be27d9e42903b32000ab1c433bb409c6751f] - Code Rule Check OK.

@seinfra
Copy link

seinfra commented Jun 14, 2018

Target : [611858650ed9ff31b04355b2cd96932eee0b438f] - Code Rule Check OK.


### State
Each Application can have four states.
![State Diagram](media/tm_state_diagram.png)
Copy link
Contributor

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)

- 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.
Copy link
Contributor

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.

: Bixby can start the Alarm application through the task manager.
: When Wi-Fi disconnection message is broadcasted, applications can receive the broadcast message.

## Features
Copy link
Contributor

Choose a reason for hiding this comment

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

Details

Builtin information should follow the [format](https://github.com/Samsung/TizenRT/tree/master/apps/builtin).


Further details are shown below.
Copy link
Contributor

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

@seinfra
Copy link

seinfra commented Jun 17, 2018

Target : [69f3234d1dbaae9346abb90d12137024ba1157da] - Code Rule Check (C++) OK.

@seinfra
Copy link

seinfra commented Jun 17, 2018

Target : [69f3234d1dbaae9346abb90d12137024ba1157da] - Code Rule Check OK.

@seinfra
Copy link

seinfra commented Jun 17, 2018

Target : [bd8faf797af17b75a953ab48628960001ebeb873] - Code Rule Check OK.

@seinfra
Copy link

seinfra commented Jun 17, 2018

Target : [bd8faf797af17b75a953ab48628960001ebeb873] - Code Rule Check (C++) OK.

@jeongchanKim jeongchanKim force-pushed the tm_readme branch 2 times, most recently from 775cc88 to 8802883 Compare June 18, 2018 08:21
@seinfra
Copy link

seinfra commented Jun 18, 2018

Target : [880288370e8fb7d272c3d012393588c590813f2a] - Code Rule Check OK.

@seinfra
Copy link

seinfra commented Jun 18, 2018

Target : [880288370e8fb7d272c3d012393588c590813f2a] - Code Rule Check (C++) OK.

@jeongchanKim jeongchanKim force-pushed the tm_readme branch 3 times, most recently from 5780669 to 5d19f8f Compare June 21, 2018 06:36
@seinfra
Copy link

seinfra commented Jun 21, 2018

Target : [7273669bcf4bc0d43563c23d4714c1e4808c465c] -

1 similar comment
@seinfra
Copy link

seinfra commented Jun 21, 2018

Target : [7273669bcf4bc0d43563c23d4714c1e4808c465c] -

@seinfra
Copy link

seinfra commented Jun 21, 2018

Target : [5d19f8f52c017aeefcd8e86dd29ecdba9cc7250e] - Code Rule Check (C++) OK.

@seinfra
Copy link

seinfra commented Jun 21, 2018

Target : [5d19f8f52c017aeefcd8e86dd29ecdba9cc7250e] - Code Rule Check OK.



## 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).
Copy link
Contributor

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.

@seinfra
Copy link

seinfra commented Jun 24, 2018

Target : [ac952e19c85daffc143d44e0d56fc8cf2d69299e] - Code Rule Check (C++) OK.

@seinfra
Copy link

seinfra commented Jun 24, 2018

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
@seinfra
Copy link

seinfra commented Jun 25, 2018

Target : [3584c45] - Code Rule Check OK.

@seinfra
Copy link

seinfra commented Jun 25, 2018

Target : [3584c45] - Code Rule Check (C++) OK.

@sunghan-chang sunghan-chang merged commit add1da9 into Samsung:master Jun 27, 2018
@jeongchanKim jeongchanKim deleted the tm_readme branch July 5, 2018 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants