Skip to content

Document runtime config directory options #66593

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.

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

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Document runtime config directory options #66593

merged 1 commit into from
Aug 28, 2024

Conversation

xbjfk
Copy link
Contributor

@xbjfk xbjfk commented Sep 17, 2023

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.

@llvmbot llvmbot added the clang Clang issues not falling into any other category label Sep 17, 2023
@llvmbot
Copy link
Member

llvmbot commented Sep 17, 2023

@llvm/pr-subscribers-clang

Changes

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.

Full diff: https://github.com/llvm/llvm-project/pull/66593.diff

1 Files Affected:

  • (modified) clang/docs/UsersManual.rst (+7-4)
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 25bbd72c81f7a3b..e180f77793e80b7 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -944,10 +944,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

@Sirraide
Copy link
Member

(Requesting another approval since this has been left open for a while now)

@xbjfk
Copy link
Contributor Author

xbjfk commented Aug 28, 2024

Thanks guys, could one of you merge it for me, since I dont have commit access?

@Sirraide Sirraide merged commit 15405b3 into llvm:main Aug 28, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants