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

doc: build/config/settings fix confusing descriptions #63725

Merged
merged 2 commits into from
Oct 12, 2023
Merged

doc: build/config/settings fix confusing descriptions #63725

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07f2e5b
doc: build:kconfig:settings align with guidelines
yf13 Oct 11, 2023
03b0c69
doc: build:kconfig:settings rewise CONF_FILE description
yf13 Oct 11, 2023
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
14 changes: 7 additions & 7 deletions doc/build/kconfig/setting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ known as a Kconfig fragment, which are then merged to get the final
configuration used for a particular build). By default, :file:`prj.conf` is
used.

1. If ``CONF_FILE`` is set, the configuration file(s) specified in it are
#. If ``CONF_FILE`` is set, the configuration file(s) specified in it are
merged and used as the application configuration. ``CONF_FILE`` can be set
in various ways:

Expand All @@ -149,25 +149,25 @@ used.

3. From the CMake variable cache

2. Otherwise if ``CONF_FILE`` is set, and a single configuration file of the
form :file:`prj_<build>.conf` is used, then if file
Furthermore if ``CONF_FILE`` is set as single configuration file of the
form :file:`prj_<build>.conf` and if file
:file:`boards/<BOARD>_<build>.conf` exists in same folder as file
:file:`prj_<build>.conf`, the result of merging :file:`prj_<build>.conf` and
:file:`boards/<BOARD>_<build>.conf` is used.

3. Otherwise, :file:`prj_<BOARD>.conf` is used if it exists in the application
#. Otherwise, :file:`prj_<BOARD>.conf` is used if it exists in the application
configuration directory.

4. Otherwise, if :file:`boards/<BOARD>.conf` exists in the application
#. Otherwise, if :file:`boards/<BOARD>.conf` exists in the application
configuration directory, the result of merging it with :file:`prj.conf` is
used.

5. Otherwise, if board revisions are used and
#. Otherwise, if board revisions are used and
:file:`boards/<BOARD>_<revision>.conf` exists in the application
configuration directory, the result of merging it with :file:`prj.conf` and
:file:`boards/<BOARD>.conf` is used.

6. Otherwise, :file:`prj.conf` is used from the application configuration
#. Otherwise, :file:`prj.conf` is used from the application configuration
directory. If it does not exist then a fatal error will be emitted.

All configuration files will be taken from the application's configuration
Expand Down
Loading