Skip to content

Commit 15405b3

Browse files
authored
[Clang] [Docs] Document runtime config directory options (#66593)
In the clang user manual the build options `CLANG_CONFIG_FILE_USER_DIR` and `CLANG_CONFIG_FILE_SYSTEM_DIR` are documented, but the run time overrides `--config-user-dir` and `--config-system-dir` are not. I have updated the manual to add these run time arguments.
1 parent 53d1c21 commit 15405b3

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

clang/docs/UsersManual.rst

+7-4
Original file line numberDiff line numberDiff line change
@@ -950,10 +950,13 @@ treated as a file name and is searched for sequentially in the directories:
950950
- system directory,
951951
- the directory where Clang executable resides.
952952

953-
Both user and system directories for configuration files are specified during
954-
clang build using CMake parameters, ``CLANG_CONFIG_FILE_USER_DIR`` and
955-
``CLANG_CONFIG_FILE_SYSTEM_DIR`` respectively. The first file found is used.
956-
It is an error if the required file cannot be found.
953+
Both user and system directories for configuration files can be specified
954+
either during build or during runtime. At build time, use
955+
``CLANG_CONFIG_FILE_USER_DIR`` and ``CLANG_CONFIG_FILE_SYSTEM_DIR``. At run
956+
time use the ``--config-user-dir=`` and ``--config-system-dir=`` command line
957+
options. Specifying config directories at runtime overrides the config
958+
directories set at build time The first file found is used. It is an error if
959+
the required file cannot be found.
957960

958961
The default configuration files are searched for in the same directories
959962
following the rules described in the next paragraphs. Loading default

0 commit comments

Comments
 (0)