You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: doc/nrf/templates/application_README.rst
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,19 +109,21 @@ Some title*
109
109
Configuration options*
110
110
======================
111
111
112
+
Check and configure the following Kconfig options:
113
+
112
114
.. 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.
118
116
119
-
Check and configure the following Kconfig options:
117
+
.. code-block::
120
118
121
-
.. _CONFIG_APPLICATION:
119
+
.. options-from-kconfig::
120
+
:show-type:
122
121
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.
Copy file name to clipboardExpand all lines: doc/nrf/templates/sample_README.rst
+11-16Lines changed: 11 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,6 +68,7 @@ In addition, it uses the ``:ref:RST link`` sound sensor and hooks up to some Int
68
68
69
69
Some title*
70
70
===========
71
+
71
72
.. note::
72
73
Add subsections for technical details.
73
74
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.
87
88
88
89
User interface*
89
90
***************
91
+
90
92
.. note::
91
93
Add button and LED assignments here, plus other information related to the user interface (for example, supported commands).
92
94
@@ -124,27 +126,20 @@ Setup*
124
126
Configuration options*
125
127
======================
126
128
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
-
133
129
Check and configure the following Kconfig options:
134
130
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.
141
133
142
-
ANOTHER_CONFIG
143
-
This configuration option specifies ...
134
+
.. code-block::
144
135
145
-
.. note::
136
+
.. options-from-kconfig::
137
+
:show-type:
146
138
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.
0 commit comments