Skip to content

Commit 3628730

Browse files
divipillairlubos
authored andcommitted
doc: Updates to Kconfig syntax in the sample and application templates
Updates to the sample and application-specific Kconfig option syntax in the sample and application templates Signed-off-by: divya pillai <[email protected]>
1 parent 9e14b6e commit 3628730

File tree

2 files changed

+22
-25
lines changed

2 files changed

+22
-25
lines changed

doc/nrf/templates/application_README.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,19 +109,21 @@ Some title*
109109
Configuration options*
110110
======================
111111

112+
Check and configure the following Kconfig options:
113+
112114
.. note::
113-
* List only important configuration options of the application in this section.
114-
Make sure all other configuration options are listed in the section at the bottom of the page.
115-
* The syntax below allows application configuration options to link to the option descriptions in the same way as the library configuration options link to the corresponding Kconfig descriptions (``:kconfig:option:`CONFIG_APPLICATION```, which results in :kconfig:option:`CONFIG_APPLICATION`).
116-
* For each configuration option, list the symbol name and the string describing it.
117-
* For the |nRFVSC| instructions, list the configuration options as they are stated on the **Generate Configuration** screen.
115+
* Use the following syntax to list all the sample-specific configuration options in the :file:`Kconfig` file.
118116

119-
Check and configure the following Kconfig options:
117+
.. code-block::
120118
121-
.. _CONFIG_APPLICATION:
119+
.. options-from-kconfig::
120+
:show-type:
122121
123-
CONFIG_APPLICATION
124-
The application configuration specifies ...
122+
Make sure all other configuration options are listed in the section at the bottom of the page.
123+
* The syntax allows application configuration options to link to the option descriptions in the same way as the library configuration options link to the corresponding Kconfig descriptions (``:kconfig:option:`CONFIG_APPLICATION```, which results in :kconfig:option:`CONFIG_APPLICATION`).
124+
* For the |nRFVSC| instructions, list the configuration options as they are stated on the **Generate Configuration** screen.
125+
* Use ``:option:`SAMPLE_CONFIG``` to link to sample specific option.
126+
* The tech writer team needs to review the :file:`Kconfig` file, where the sample-specific Kconfig options are defined.
125127

126128
Additional configuration*
127129
=========================

doc/nrf/templates/sample_README.rst

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ In addition, it uses the ``:ref:RST link`` sound sensor and hooks up to some Int
6868

6969
Some title*
7070
===========
71+
7172
.. note::
7273
Add subsections for technical details.
7374
Give them a suitable title (sentence style capitalization, thus only the first word capitalized).
@@ -87,6 +88,7 @@ Connect PIN1 to PIN2, then cut the connection again.
8788

8889
User interface*
8990
***************
91+
9092
.. note::
9193
Add button and LED assignments here, plus other information related to the user interface (for example, supported commands).
9294

@@ -124,27 +126,20 @@ Setup*
124126
Configuration options*
125127
======================
126128

127-
.. note::
128-
* You do not need to list all configuration options of the sample, but only the ones that are important for the sample and make sense for the user to know about.
129-
* The syntax below allows sample configuration options to link to the option descriptions in the same way as the library configuration options link to the corresponding Kconfig descriptions (``:kconfig:option:`SAMPLE_CONFIG```, which results in :kconfig:option:`SAMPLE_CONFIG`).
130-
* For each configuration option, list the symbol name and the string describing it.
131-
* For the |nRFVSC| instructions, list the configuration options as they are stated on the Generate Configuration screen.
132-
133129
Check and configure the following Kconfig options:
134130

135-
.. _SAMPLE_CONFIG:
136-
137-
SAMPLE_CONFIG
138-
The sample configuration defines ...
139-
140-
.. _ANOTHER_CONFIG:
131+
.. note::
132+
* Use the following syntax to list all the sample-specific configuration options in the :file:`Kconfig` file.
141133

142-
ANOTHER_CONFIG
143-
This configuration option specifies ...
134+
.. code-block::
144135
145-
.. note::
136+
.. options-from-kconfig::
137+
:show-type:
146138
147-
Use :ref:`SAMPLE_CONFIG <SAMPLE_CONFIG>` to link to sample specific option.
139+
* The syntax allows sample configuration options to link to the option descriptions in the same way as the library configuration options link to the corresponding Kconfig descriptions (``:kconfig:option:`SAMPLE_CONFIG```, which results in :kconfig:option:`SAMPLE_CONFIG`).
140+
* For the |nRFVSC| instructions, list the configuration options as they are stated on the **Generate Configuration** screen.
141+
* Use ``:option:`SAMPLE_CONFIG``` to link to sample specific option from any documentation page.
142+
* The tech writer team needs to review the :file:`Kconfig` file, where the sample-specific Kconfig options are defined.
148143

149144
Additional configuration*
150145
=========================

0 commit comments

Comments
 (0)