bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: develop: Add XDG_CONFIG_HOME information for zephyrrc

Browse Source 
The `zephyr-env.sh` script was adjusted to look for the zephyrrc file in
three locations following the [XDG Base Directory Specification]. The
documentation of the environment variables is now adjusted to reflect that
change.

[XDG Base Directory Specification]: (https://specifications.freedesktop.org/basedir-spec/latest/)

Signed-off-by: Andreas Schuster <andreas.schuster@schuam.de>
This commit is contained in:
Andreas Schuster 2025-06-19 11:37:58 +02:00 committed by Dan Kalowsky
parent 0f0497f9c5
commit 972f11e9e4
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/develop/env_vars.rst
View File

@ -88,8 +88,16 @@ your environment when you are using Zephyr.
.. group-tab:: Linux/macOS
Create a file named :file:`~/.zephyrrc` if it doesn't exist, then add this
line to it:
Zephyr supports multiple locations for your :file:`zephyrrc` file,
following the XDG Base Directory Specification when possible. Create a
zephyrrc file in one of the following locations (they will be checked in
order):
#. :file:`$XDG_CONFIG_HOME/zephyr/zephyrrc`
#. :file:`$HOME/.config/zephyr/zephyrrc`
#. :file:`$HOME/.zephyrrc`
Add this line to the file in your preferred location:
.. code-block:: console
@ -97,7 +105,8 @@ your environment when you are using Zephyr.
To get this value back into your current terminal environment, **you must
run** ``source zephyr-env.sh`` from the main ``zephyr`` repository. Among
other things, this script sources :file:`~/.zephyrrc`.
other things, this script sources your :file:`zephyrrc` (the first one it
finds from the list of locations above).
The value will be lost if you close the window, etc.; run ``source
zephyr-env.sh`` again to get it back.