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.

Sign up for GitHub

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

Jump to bottom

Correct error/omissions in Custom Apps guide #12052

Merged
merged 1 commit into from
Apr 4, 2024
Merged

Correct error/omissions in Custom Apps guide #12052

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 33 additions & 8 deletions Documentation/guides/customapps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ The CustomApps directory need only to contain the minimum three files:
1.1 Makefile
------------

The custom application directory must include a Makefile to make all of the targets
expected by the NuttX build and must generate an archive called libapps.a in the
top-level of the custom directory structure.
The custom application directory must include a Makefile to make all of the
targets expected by the NuttX build and must generate an archive called
libapps.a in the top-level of the custom directory structure.

The Makefile has just those minimum required targets:

Expand Down Expand Up @@ -104,9 +104,10 @@ The Makefile has just those minimum required targets:
1.2 Kconfig
-----------

A Kconfig file must be included but need not be populated with any meaningful options.
This is a place where you can add settings to generate customized builds of your custom
application and/or choose which of your apps to include.
A Kconfig file must be included but need not be populated with any meaningful
options.
This is a place where you can add settings to generate customized builds of
your custom application and/or choose which of your apps to include.

In the minimum case, Kconfig is only:

Expand All @@ -116,15 +117,39 @@ In the minimum case, Kconfig is only:
# see the file kconfig-language.txt in the NuttX tools repository.
#

or
but it is more usual to include at least the basic information any NuttX app
requires, as well as anything else your app may need:

.. code-block:: console

# For a description of the syntax of this configuration file,
# see the file kconfig-language.txt in the NuttX tools repository.
#


config CUSTOM_APPS_MY_APP
tristate "My App"
default n
---help---
Enable My App

if CUSTOM_APPS_MY_APP

config CUSTOM_APPS_MY_APP_PROGNAME
string "Program name"
default "myapp"
---help---
This is the name of the program that will be used when the NSH ELF
program is installed.

config CUSTOM_APPS_MY_APP_PRIORITY
int "My App task priority"
default 100

config CUSTOM_APPS_MY_APP_STACKSIZE
int "My App stack size"
default DEFAULT_TASK_STACKSIZE

endif

1.3 CustomHello.c
-----------------
Expand Down
Loading