sched: Improve Kconfig help of INIT_ENTRYPOINT

* sched/Kconfig
  (INIT_ENTRYPOINT): Document that the signature of "main" must take
   "argc" and "argv" or else compilation error results, as discussed in
   the email thread below [1].

References:

[1] dev@nuttx.apache.org email thread:
    "basically, I get an error when I do make" started 18 Jul 2024,
    archived:
    https://lists.apache.org/thread/9j2s3647ysdhy204g4ombn4o09bn11c1
    and elsewhere.
This commit is contained in:
Nathan Hartman 2024-07-21 11:56:41 -04:00 committed by Alan Carvalho de Assis
parent e2aeb5cd11
commit b8561558e7

View File

@ -445,6 +445,20 @@ config INIT_ENTRYPOINT
applications this is of the form 'app_main' where 'app' is the application applications this is of the form 'app_main' where 'app' is the application
name. If not defined, INIT_ENTRYPOINT defaults to "main". name. If not defined, INIT_ENTRYPOINT defaults to "main".
Note that main must take "argc" and "argv" arguments:
int main(int argc, FAR char *argv[])
Otherwise, if using a signature such as "int main(void)" a compilation
error will result:
> $ make
> CC: CustomHello.c <command-line>: error: conflicting types for
> 'custom_hello_main'
> CustomHello.c:3:5: note: in expansion of macro 'main'
> 3 | int main(void)
> | ^~~~
config INIT_ENTRYNAME config INIT_ENTRYNAME
string "Application entry name" string "Application entry name"
default INIT_ENTRYPOINT default INIT_ENTRYPOINT