sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update some comments. Remove references to non-existent CONFIG_MAX_TASK_ARG.

Browse Source
This commit is contained in:
Gregory Nutt 2018-08-08 17:06:46 -06:00
parent 5433c9f6d1
commit 3973640fff
5 changed files with 13 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/NuttxUserGuide.html
View File

@ -307,10 +307,8 @@ int task_create(char *name, int priority, int stack_size, main_t entry, char * c
<li><code>priority</code>. Priority of the new task</LI> <li><code>priority</code>. Priority of the new task</LI>
<li><code>stack_size</code>. size (in bytes) of the stack needed</LI> <li><code>stack_size</code>. size (in bytes) of the stack needed</LI>
<li><code>entry</code>. Entry point of a new task</LI> <li><code>entry</code>. Entry point of a new task</LI>
<li><code>argv</code>. A pointer to an array of input parameters. Up to <li><code>argv</code>. A pointer to an array of input parameters.
<code>CONFIG_MAX_TASK_ARG</code> parameters may be provided. The array should be terminated with a NULL argv[] value.
If fewer than <code>CONFIG_MAX_TASK_ARG</code> parameters are
passed, the list should be terminated with a NULL argv[] value.
If no parameters are required, argv may be NULL. If no parameters are required, argv may be NULL.
</ul> </ul>
<p> <p>
@ -376,10 +374,8 @@ VxWorks provides the following similar interface:
<li><code>stack</code>. Start of the pre-allocated stack <li><code>stack</code>. Start of the pre-allocated stack
<li><code>stack_size</code>. size (in bytes) of the pre-allocated stack <li><code>stack_size</code>. size (in bytes) of the pre-allocated stack
<li><code>entry</code>. Entry point of a new task <li><code>entry</code>. Entry point of a new task
<li><code>argv</code>. A pointer to an array of input parameters. Up to <li><code>argv</code>. A pointer to an array of input parameters.
<code>CONFIG_MAX_TASK_ARG</code> parameters may be provided. The array should be terminated with a NULL argv[] value.
If fewer than <code>CONFIG_MAX_TASK_ARG</code> parameters are
passed, the list should be terminated with a NULL argv[] value.
If no parameters are required, argv may be NULL. If no parameters are required, argv may be NULL.
</ul> </ul>
</p> </p>

8
include/nuttx/kthread.h
View File

@ -91,9 +91,7 @@ extern "C"
* priority - Priority of the new task * priority - Priority of the new task
* stack_size - size (in bytes) of the stack needed * stack_size - size (in bytes) of the stack needed
* entry - Entry point of a new task * entry - Entry point of a new task
* arg - A pointer to an array of input parameters. Up to * arg - A pointer to an array of input parameters. The array
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer
* than CONFIG_MAX_TASK_ARG parameters are passed, the list
* should be terminated with a NULL argv[] value. If no * should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL. * parameters are required, argv may be NULL.
* *
@ -120,9 +118,7 @@ int nxtask_create(FAR const char *name, int priority,
* priority - Priority of the new task * priority - Priority of the new task
* stack_size - size (in bytes) of the stack needed * stack_size - size (in bytes) of the stack needed
* entry - Entry point of a new task * entry - Entry point of a new task
* arg - A pointer to an array of input parameters. Up to * arg - A pointer to an array of input parameters. The array
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer
* than CONFIG_MAX_TASK_ARG parameters are passed, the list
* should be terminated with a NULL argv[] value. If no * should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL. * parameters are required, argv may be NULL.
* *

16
sched/task/task_create.c
View File

@ -72,9 +72,7 @@
* priority - Priority of the new task * priority - Priority of the new task
* stack_size - size (in bytes) of the stack needed * stack_size - size (in bytes) of the stack needed
* entry - Entry point of a new task * entry - Entry point of a new task
* arg - A pointer to an array of input parameters. Up to * arg - A pointer to an array of input parameters. The array
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer
* than CONFIG_MAX_TASK_ARG parameters are passed, the list
* should be terminated with a NULL argv[] value. If no * should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL. * parameters are required, argv may be NULL.
* *
@ -218,9 +216,7 @@ errout_with_tcb:
* priority - Priority of the new task * priority - Priority of the new task
* stack_size - size (in bytes) of the stack needed * stack_size - size (in bytes) of the stack needed
* entry - Entry point of a new task * entry - Entry point of a new task
* arg - A pointer to an array of input parameters. Up to * arg - A pointer to an array of input parameters. The array
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer
* than CONFIG_MAX_TASK_ARG parameters are passed, the list
* should be terminated with a NULL argv[] value. If no * should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL. * parameters are required, argv may be NULL.
* *
@ -259,9 +255,7 @@ int nxtask_create(FAR const char *name, int priority,
* priority - Priority of the new task * priority - Priority of the new task
* stack_size - size (in bytes) of the stack needed * stack_size - size (in bytes) of the stack needed
* entry - Entry point of a new task * entry - Entry point of a new task
* arg - A pointer to an array of input parameters. Up to * arg - A pointer to an array of input parameters. The array
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer
* than CONFIG_MAX_TASK_ARG parameters are passed, the list
* should be terminated with a NULL argv[] value. If no * should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL. * parameters are required, argv may be NULL.
* *
@ -300,9 +294,7 @@ int task_create(FAR const char *name, int priority,
* priority - Priority of the new task * priority - Priority of the new task
* stack_size - size (in bytes) of the stack needed * stack_size - size (in bytes) of the stack needed
* entry - Entry point of a new task * entry - Entry point of a new task
* arg - A pointer to an array of input parameters. Up to * arg - A pointer to an array of input parameters. The array
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer
* than CONFIG_MAX_TASK_ARG parameters are passed, the list
* should be terminated with a NULL argv[] value. If no * should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL. * parameters are required, argv may be NULL.
* *

4
sched/task/task_init.c
View File

@ -74,9 +74,7 @@
* stack - Start of the pre-allocated stack * stack - Start of the pre-allocated stack
* stack_size - Size (in bytes) of the stack allocated * stack_size - Size (in bytes) of the stack allocated
* entry - Application start point of the new task * entry - Application start point of the new task
* arg - A pointer to an array of input parameters. Up to * arg - A pointer to an array of input parameters. The array
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer
* than CONFIG_MAX_TASK_ARG parameters are passed, the list
* should be terminated with a NULL argv[] value. If no * should be terminated with a NULL argv[] value. If no
* parameters are required, argv may be NULL. * parameters are required, argv may be NULL.
* *

8
sched/task/task_setup.c
View File

@ -485,9 +485,7 @@ static void task_namesetup(FAR struct task_tcb_s *tcb, FAR const char *name)
* *
* Input Parameters: * Input Parameters:
* tcb - Address of the new task's TCB * tcb - Address of the new task's TCB
* argv - A pointer to an array of input parameters. Up to * argv - A pointer to an array of input parameters. The arrau should be
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer than
* CONFIG_MAX_TASK_ARG parameters are passed, the list should be
* terminated with a NULL argv[] value. If no parameters are * terminated with a NULL argv[] value. If no parameters are
* required, argv may be NULL. * required, argv may be NULL.
* *
@ -703,9 +701,7 @@ int pthread_schedsetup(FAR struct pthread_tcb_s *tcb, int priority,
* Input Parameters: * Input Parameters:
* tcb - Address of the new task's TCB * tcb - Address of the new task's TCB
* name - Name of the new task (not used) * name - Name of the new task (not used)
* argv - A pointer to an array of input parameters. Up to * argv - A pointer to an array of input parameters. The array should be
* CONFIG_MAX_TASK_ARG parameters may be provided. If fewer than
* CONFIG_MAX_TASK_ARG parameters are passed, the list should be
* terminated with a NULL argv[] value. If no parameters are * terminated with a NULL argv[] value. If no parameters are
* required, argv may be NULL. * required, argv may be NULL.
* *