[clang] 15405b3 - [Clang] [Docs] Document runtime config directory options (#66593)
via cfe-commits
cfe-commits at lists.llvm.org
Wed Aug 28 03:54:30 PDT 2024
Author: Reagan
Date: 2024-08-28T12:54:28+02:00
New Revision: 15405b32b1cdbefab9ce1b1f301a51ae25404037
URL: https://github.com/llvm/llvm-project/commit/15405b32b1cdbefab9ce1b1f301a51ae25404037
DIFF: https://github.com/llvm/llvm-project/commit/15405b32b1cdbefab9ce1b1f301a51ae25404037.diff
LOG: [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.
Added:
Modified:
clang/docs/UsersManual.rst
Removed:
################################################################################
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 069ecba875cd59..f27fa4ace917ea 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -950,10 +950,13 @@ treated as a file name and is searched for sequentially in the directories:
- system directory,
- the directory where Clang executable resides.
-Both user and system directories for configuration files are specified during
-clang build using CMake parameters, ``CLANG_CONFIG_FILE_USER_DIR`` and
-``CLANG_CONFIG_FILE_SYSTEM_DIR`` respectively. The first file found is used.
-It is an error if the required file cannot be found.
+Both user and system directories for configuration files can be specified
+either during build or during runtime. At build time, use
+``CLANG_CONFIG_FILE_USER_DIR`` and ``CLANG_CONFIG_FILE_SYSTEM_DIR``. At run
+time use the ``--config-user-dir=`` and ``--config-system-dir=`` command line
+options. Specifying config directories at runtime overrides the config
+directories set at build time The first file found is used. It is an error if
+the required file cannot be found.
The default configuration files are searched for in the same directories
following the rules described in the next paragraphs. Loading default
More information about the cfe-commits
mailing list