From 3973640fff956b32d4a6b11debdeb012996ab08c Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Wed, 8 Aug 2018 17:06:46 -0600 Subject: [PATCH] Update some comments. Remove references to non-existent CONFIG_MAX_TASK_ARG. --- Documentation/NuttxUserGuide.html | 12 ++++-------- include/nuttx/kthread.h | 8 ++------ sched/task/task_create.c | 16 ++++------------ sched/task/task_init.c | 4 +--- sched/task/task_setup.c | 8 ++------ 5 files changed, 13 insertions(+), 35 deletions(-) diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html index fb5bec36bb..a3fd8e55a7 100644 --- a/Documentation/NuttxUserGuide.html +++ b/Documentation/NuttxUserGuide.html @@ -307,10 +307,8 @@ int task_create(char *name, int priority, int stack_size, main_t entry, char * c
  • priority. Priority of the new task
  • stack_size. size (in bytes) of the stack needed
  • entry. Entry point of a new task
    • -
  • argv. A pointer to an array of input parameters. Up to - 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. +
  • argv. A pointer to an array of input parameters. + The array should be terminated with a NULL argv[] value. If no parameters are required, argv may be NULL.

    @@ -376,10 +374,8 @@ VxWorks provides the following similar interface:

  • stack. Start of the pre-allocated stack
  • stack_size. size (in bytes) of the pre-allocated stack
  • entry. Entry point of a new task -
  • argv. A pointer to an array of input parameters. Up to - 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. +
  • argv. A pointer to an array of input parameters. + The array should be terminated with a NULL argv[] value. If no parameters are required, argv may be NULL.

    diff --git a/include/nuttx/kthread.h b/include/nuttx/kthread.h index c9f2ffaf70..9f745483c4 100644 --- a/include/nuttx/kthread.h +++ b/include/nuttx/kthread.h @@ -91,9 +91,7 @@ extern "C" * priority - Priority of the new task * stack_size - size (in bytes) of the stack needed * entry - Entry point of a new task - * arg - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer - * than CONFIG_MAX_TASK_ARG parameters are passed, the list + * arg - A pointer to an array of input parameters. The array * should be terminated with a NULL argv[] value. If no * 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 * stack_size - size (in bytes) of the stack needed * entry - Entry point of a new task - * arg - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer - * than CONFIG_MAX_TASK_ARG parameters are passed, the list + * arg - A pointer to an array of input parameters. The array * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * diff --git a/sched/task/task_create.c b/sched/task/task_create.c index f09d04578c..88e1351e04 100644 --- a/sched/task/task_create.c +++ b/sched/task/task_create.c @@ -72,9 +72,7 @@ * priority - Priority of the new task * stack_size - size (in bytes) of the stack needed * entry - Entry point of a new task - * arg - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer - * than CONFIG_MAX_TASK_ARG parameters are passed, the list + * arg - A pointer to an array of input parameters. The array * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * @@ -218,9 +216,7 @@ errout_with_tcb: * priority - Priority of the new task * stack_size - size (in bytes) of the stack needed * entry - Entry point of a new task - * arg - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer - * than CONFIG_MAX_TASK_ARG parameters are passed, the list + * arg - A pointer to an array of input parameters. The array * should be terminated with a NULL argv[] value. If no * 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 * stack_size - size (in bytes) of the stack needed * entry - Entry point of a new task - * arg - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer - * than CONFIG_MAX_TASK_ARG parameters are passed, the list + * arg - A pointer to an array of input parameters. The array * should be terminated with a NULL argv[] value. If no * 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 * stack_size - size (in bytes) of the stack needed * entry - Entry point of a new task - * arg - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer - * than CONFIG_MAX_TASK_ARG parameters are passed, the list + * arg - A pointer to an array of input parameters. The array * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * diff --git a/sched/task/task_init.c b/sched/task/task_init.c index 2d15f84736..1900e5d1cd 100644 --- a/sched/task/task_init.c +++ b/sched/task/task_init.c @@ -74,9 +74,7 @@ * stack - Start of the pre-allocated stack * stack_size - Size (in bytes) of the stack allocated * entry - Application start point of the new task - * arg - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer - * than CONFIG_MAX_TASK_ARG parameters are passed, the list + * arg - A pointer to an array of input parameters. The array * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * diff --git a/sched/task/task_setup.c b/sched/task/task_setup.c index fd1105d1eb..3349f5a2b6 100644 --- a/sched/task/task_setup.c +++ b/sched/task/task_setup.c @@ -485,9 +485,7 @@ static void task_namesetup(FAR struct task_tcb_s *tcb, FAR const char *name) * * Input Parameters: * tcb - Address of the new task's TCB - * argv - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer than - * CONFIG_MAX_TASK_ARG parameters are passed, the list should be + * argv - A pointer to an array of input parameters. The arrau should be * terminated with a NULL argv[] value. If no parameters are * required, argv may be NULL. * @@ -703,9 +701,7 @@ int pthread_schedsetup(FAR struct pthread_tcb_s *tcb, int priority, * Input Parameters: * tcb - Address of the new task's TCB * name - Name of the new task (not used) - * argv - A pointer to an array of input parameters. Up to - * CONFIG_MAX_TASK_ARG parameters may be provided. If fewer than - * CONFIG_MAX_TASK_ARG parameters are passed, the list should be + * argv - A pointer to an array of input parameters. The array should be * terminated with a NULL argv[] value. If no parameters are * required, argv may be NULL. *