[PATCH] D115533: [docs] Document all llvm-config command-line options

[fw via Phabricator via llvm-commits]

fw-immunant created this revision.
fw-immunant added reviewers: jhenderson, andreadb.
fw-immunant requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

These are mostly just copy-pasted from the `--help` output, but it's good to keep different docs in sync.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D115533

Files:
  llvm/docs/CommandGuide/llvm-config.rst


Index: llvm/docs/CommandGuide/llvm-config.rst
===================================================================
--- llvm/docs/CommandGuide/llvm-config.rst
+++ llvm/docs/CommandGuide/llvm-config.rst
@@ -29,13 +29,13 @@
 OPTIONS
 -------
 
-**--version**
+**--help**
 
- Print the version number of LLVM.
+ Print a summary of **llvm-config** arguments.
 
-**-help**
+**--version**
 
- Print a summary of **llvm-config** arguments.
+ Print the version number of LLVM.
 
 **--prefix**
 
@@ -61,6 +61,18 @@
 
  Print the installation directory for LLVM libraries.
 
+**--cmakedir**
+
+ Print the installation directory for LLVM cmake modules.
+
+**--cppflags**
+
+ Print the C preprocessor flags needed to use LLVM headers.
+
+**--cflags**
+
+ Print the C compiler flags needed to use LLVM headers.
+
 **--cxxflags**
 
  Print the C++ compiler flags needed to use LLVM headers.
@@ -69,6 +81,11 @@
 
  Print the flags needed to link against LLVM libraries.
 
+**--system-libs**
+
+ Print all the system libraries needed to link against the specified LLVM
+ *components*, including any dependencies.
+
 **--libs**
 
  Print all the libraries needed to link against the specified LLVM
@@ -94,9 +111,41 @@
 
  Print the component names for all targets supported by this copy of LLVM.
 
+**--host-target**
+
+ Print the target triple used to configure LLVM.
+
 **--build-mode**
 
- Print the build mode used when LLVM was built (e.g. Debug or Release)
+ Print the build mode used when LLVM was built (e.g. Debug or Release).
+
+**--assertion-mode**
+
+ Print the assertion mode used when LLVM was built (ON or OFF).
+
+**--build-system**
+
+ Print the build system used to build LLVM (always cmake).
+
+**--has-rtti**
+
+ Print whether or not LLVM was built with rtti (YES or NO).
+
+**--shared-mode**
+
+ Print how the provided components can be collectively linked (`shared` or `static`).
+
+**--link-shared**
+
+ Link the components as shared libraries.
+
+**--link-static**
+
+ Link the component libraries statically.
+
+**--ignore-libllvm**
+
+ Ignore libLLVM and link component libraries instead.
 
 
 COMPONENTS


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D115533.393515.patch
Type: text/x-patch
Size: 2112 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20211210/baf7a45b/attachment.bin>