[llvm-branch-commits] [clang] [docs] Use intersphinx for Clang cross-project links (PR #239865)

via llvm-branch-commits llvm-branch-commits at lists.llvm.org
Fri Nov 6 17:17:39 PST 2026


llvmorg-github-actions[bot] wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang

Author: Reid Kleckner (rnk)

<details>
<summary>Changes</summary>

Use the shared intersphinx mapping in the Clang docs and replace absolute URLs to LLVM and other subprojects with `inv:` links, including the references in `AttrDocs.td`. This enables `sphinx.ext.intersphinx` for the Clang docs configuration.

Links are validated against the inventories at build time, and a downstream or release build can retarget the mapping. `clang/Maintainers.md` keeps its absolute URL because the file is mainly read on GitHub, where `inv:` links do not resolve. Some other links to LLVM are intentionally left for follow-up changes.

Part of #<!-- -->214861. This is the third of three stacked PRs and depends on the two PRs below it.

LLM-aided


---

Patch is 45.99 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/239865.diff


35 Files Affected:

- (modified) clang/docs/AddressSanitizer.md (+1-1) 
- (modified) clang/docs/BoundsSafety/BoundsSafetyAdoptionGuide.md (+1-1) 
- (modified) clang/docs/CIR/CleanupAndEHDesign.md (+2-2) 
- (modified) clang/docs/ClangFormatStyleOptions.md (+1-1) 
- (modified) clang/docs/ClangOffloadBundler.md (+4-5) 
- (modified) clang/docs/ClangTools.md (+5-6) 
- (modified) clang/docs/ClangTransformerTutorial.md (+1-1) 
- (modified) clang/docs/ControlFlowIntegrity.md (+1-1) 
- (modified) clang/docs/ControlFlowIntegrityDesign.md (+1-1) 
- (modified) clang/docs/CrossCompilation.md (+1-2) 
- (modified) clang/docs/DebuggingCoroutines.md (+1-2) 
- (modified) clang/docs/HIPSupport.md (+2-2) 
- (modified) clang/docs/InternalsManual.md (+6-6) 
- (modified) clang/docs/LLVMExceptionHandlingCodeGen.md (+1-2) 
- (modified) clang/docs/LanguageExtensions.md (+11-11) 
- (modified) clang/docs/LibASTMatchersTutorial.md (+2-2) 
- (modified) clang/docs/MemorySanitizer.md (+1-1) 
- (modified) clang/docs/OffloadingDesign.md (+1-1) 
- (modified) clang/docs/OpenCLSupport.md (+1-1) 
- (modified) clang/docs/PCHInternals.md (+3-4) 
- (modified) clang/docs/RealtimeSanitizer.md (+1-1) 
- (modified) clang/docs/ReleaseNotes.md (+3-3) 
- (modified) clang/docs/SafeBuffers.md (+2-2) 
- (modified) clang/docs/SanitizerCoverage.md (+1-1) 
- (modified) clang/docs/SourceBasedCodeCoverage.md (+2-2) 
- (modified) clang/docs/ThinLTO.md (+6-6) 
- (modified) clang/docs/ThreadSanitizer.md (+1-1) 
- (modified) clang/docs/Toolchain.md (+3-3) 
- (modified) clang/docs/TypeSanitizer.md (+1-1) 
- (modified) clang/docs/UndefinedBehaviorSanitizer.md (+1-1) 
- (modified) clang/docs/UsersManual.md (+1-1) 
- (modified) clang/docs/analyzer/developer-docs/PerformanceInvestigation.md (+1-2) 
- (modified) clang/docs/analyzer/user-docs/FilingBugs.md (+1-2) 
- (modified) clang/docs/conf.py (+3) 
- (modified) clang/include/clang/Basic/AttrDocs.td (+4-4) 


``````````diff
diff --git a/clang/docs/AddressSanitizer.md b/clang/docs/AddressSanitizer.md
index 19276261b7562..35a56ef4af1db 100644
--- a/clang/docs/AddressSanitizer.md
+++ b/clang/docs/AddressSanitizer.md
@@ -20,7 +20,7 @@ Typical slowdown introduced by AddressSanitizer is **2x**.
 
 ## How to build
 
-Build LLVM/Clang with [CMake](https://llvm.org/docs/CMake.html) and enable
+Build LLVM/Clang with [CMake](inv:llvm:std:doc#CMake) and enable
 the `compiler-rt` runtime. An example CMake configuration that will allow
 for the use/testing of AddressSanitizer:
 
diff --git a/clang/docs/BoundsSafety/BoundsSafetyAdoptionGuide.md b/clang/docs/BoundsSafety/BoundsSafetyAdoptionGuide.md
index 39a435d321b72..97f8ec36953a7 100644
--- a/clang/docs/BoundsSafety/BoundsSafetyAdoptionGuide.md
+++ b/clang/docs/BoundsSafety/BoundsSafetyAdoptionGuide.md
@@ -8,7 +8,7 @@ feature is not available yet. In the mean time, the preview implementation is
 available
 [here](https://github.com/swiftlang/llvm-project/tree/stable/21.x) in a
 fork of `llvm-project`. Please follow
-[Building LLVM with CMake](https://llvm.org/docs/CMake.html) to build the
+[Building LLVM with CMake](inv:llvm:std:doc#CMake) to build the
 compiler.
 
 ## Feature flag
diff --git a/clang/docs/CIR/CleanupAndEHDesign.md b/clang/docs/CIR/CleanupAndEHDesign.md
index c9b95d730d8ea..38b67a086b334 100644
--- a/clang/docs/CIR/CleanupAndEHDesign.md
+++ b/clang/docs/CIR/CleanupAndEHDesign.md
@@ -1211,8 +1211,8 @@ methods for use with the exception handling ABI.
 For each supported exception handling ABI, the operations and function
 calls used will have a direct correspondence to the LLVM IR instructions
 and runtime library functions used for that ABI. The LLVM IR exception
-handling model is described in detail here: [LLVM Exception
-Handling](https://llvm.org/docs/ExceptionHandling.html).
+handling model is described in detail here:
+[LLVM Exception Handling](inv:llvm:std:doc#ExceptionHandling).
 
 A personality function attribute will be added to functions that require
 it during the ABI lowering phase.
diff --git a/clang/docs/ClangFormatStyleOptions.md b/clang/docs/ClangFormatStyleOptions.md
index c7de6fc25e1f3..9bb43829fa2b4 100644
--- a/clang/docs/ClangFormatStyleOptions.md
+++ b/clang/docs/ClangFormatStyleOptions.md
@@ -149,7 +149,7 @@ the configuration (without a prefix: `Auto`).
   Possible values:
 
   - `LLVM`
-    A style complying with the [LLVM coding standards](https://llvm.org/docs/CodingStandards.html)
+    A style complying with the [LLVM coding standards](inv:llvm:std:doc#CodingStandards)
   - `Google`
     A style complying with [Google's C++ style guide](https://google.github.io/styleguide/cppguide.html)
   - `Chromium`
diff --git a/clang/docs/ClangOffloadBundler.md b/clang/docs/ClangOffloadBundler.md
index 45f9fba0a50aa..7b0ece84516f7 100644
--- a/clang/docs/ClangOffloadBundler.md
+++ b/clang/docs/ClangOffloadBundler.md
@@ -405,11 +405,10 @@ Target-specific information is available for the following:
 
 *AMD GPU*
 
-: AMD GPU supports target ID and target features. See [User Guide for AMDGPU
-  Backend](https://llvm.org/docs/AMDGPUUsage.html) which defines the
-  [processors](https://llvm.org/docs/AMDGPUUsage.html#amdgpu-processors) and
-  [target
-  features](https://llvm.org/docs/AMDGPUUsage.html#amdgpu-target-features)
+: AMD GPU supports target ID and target features. See
+  [User Guide for AMDGPU Backend](inv:llvm:std:doc#AMDGPUUsage) which defines
+  the [processors](inv:llvm:std:label#amdgpu-processors) and
+  [target features](inv:llvm:std:label#amdgpu-target-features)
   supported.
 
 Most other targets do not support target IDs.
diff --git a/clang/docs/ClangTools.md b/clang/docs/ClangTools.md
index 3d6103dcf5b01..9245bf914458e 100644
--- a/clang/docs/ClangTools.md
+++ b/clang/docs/ClangTools.md
@@ -82,19 +82,19 @@ provide its own user-focused documentation.
 
 ### `Clang-Doc`
 
-[Clang-Doc](https://clang.llvm.org/extra/clang-doc.html) is a tool for
+[Clang-Doc](inv:clang-tools-extra:std:doc#clang-doc) is a tool for
 generating C and C++ documentation from source code and comments.
 
 ### `Clang-Include-Fixer`
 
-[Clang-Include-Fixer](https://clang.llvm.org/extra/clang-include-fixer.html)
+[Clang-Include-Fixer](inv:clang-tools-extra:std:doc#clang-include-fixer)
 is a tool to automate the addition of missing `#include` directives in a C++
 file. It adds missing namespace qualifiers to unidentified symbols when
 necessary and also removes unused headers.
 
 ### `Clang-Tidy`
 
-[Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/) is a Clang-based C++
+[Clang-Tidy](inv:clang-tools-extra:std:doc#clang-tidy/index) is a Clang-based C++
 linter tool. It provides an extensible framework for building compiler-based
 static analyses detecting and fixing bug-prone patterns, performance,
 portability and maintainability issues. It also has checks for modernizing code
@@ -109,13 +109,13 @@ more.
 
 ### `Modularize`
 
-[Modularize](https://clang.llvm.org/extra/modularize.html) is a standalone
+[Modularize](inv:clang-tools-extra:std:doc#modularize) is a standalone
 tool that checks whether a set of headers provides the consistent definitions
 required to use modules.
 
 ### `pp-trace`
 
-[pp-trace](https://clang.llvm.org/extra/pp-trace.html) is a standalone tool
+[pp-trace](inv:clang-tools-extra:std:doc#pp-trace) is a standalone tool
 that traces preprocessor activity. It’s also used as a test of Clang’s
 `PPCallbacks` interface.
 
@@ -172,4 +172,3 @@ that traces preprocessor activity. It’s also used as a test of Clang’s
   ```c++
   sort(v.begin(), v.end(), greater<>());
   ```
-
diff --git a/clang/docs/ClangTransformerTutorial.md b/clang/docs/ClangTransformerTutorial.md
index 28a7a428c7bec..ef032f3d9b399 100644
--- a/clang/docs/ClangTransformerTutorial.md
+++ b/clang/docs/ClangTransformerTutorial.md
@@ -338,7 +338,7 @@ For additional documentation on these functions, see the header file
 ## Using a RewriteRule as a clang-tidy check
 
 Transformer supports executing a rewrite rule as a
-[clang-tidy](https://clang.llvm.org/extra/clang-tidy/) check, with the class
+[clang-tidy](inv:clang-tools-extra:std:doc#clang-tidy/index) check, with the class
 `clang::tidy::utils::TransformerClangTidyCheck`. It is designed to require
 minimal code in the definition. For example, given a rule
 `MyCheckAsRewriteRule`, one can define a tidy check as follows:
diff --git a/clang/docs/ControlFlowIntegrity.md b/clang/docs/ControlFlowIntegrity.md
index c25a27fd910c5..fda6f82cb0181 100644
--- a/clang/docs/ControlFlowIntegrity.md
+++ b/clang/docs/ControlFlowIntegrity.md
@@ -408,4 +408,4 @@ Martin Abadi, Mihai Budiu, Úlfar Erlingsson, Jay Ligatti.
 Caroline Tice, Tom Roeder, Peter Collingbourne, Stephen Checkoway,
 Úlfar Erlingsson, Luis Lozano, Geoff Pike.
 
-[gold plugin]: https://llvm.org/docs/GoldPlugin.html
+[gold plugin]: inv:llvm:std:doc#GoldPlugin
diff --git a/clang/docs/ControlFlowIntegrityDesign.md b/clang/docs/ControlFlowIntegrityDesign.md
index 1b3348928c859..75bb0a42fa0a1 100644
--- a/clang/docs/ControlFlowIntegrityDesign.md
+++ b/clang/docs/ControlFlowIntegrityDesign.md
@@ -781,4 +781,4 @@ ability to protect against invalid casts between polymorphic types.
 [intel cet]: https://software.intel.com/en-us/blogs/2016/06/09/intel-release-new-technology-specifications-protect-rop-attacks
 [rfg]: https://xlab.tencent.com/en/2016/11/02/return-flow-guard
 [safestack]: SafeStack.md
-[type metadata]: https://llvm.org/docs/TypeMetadata.html
+[type metadata]: inv:llvm:std:doc#TypeMetadata
diff --git a/clang/docs/CrossCompilation.md b/clang/docs/CrossCompilation.md
index d6a0134a8fb2b..90c037bd4849a 100644
--- a/clang/docs/CrossCompilation.md
+++ b/clang/docs/CrossCompilation.md
@@ -11,7 +11,7 @@ However, this document is *not* a "how to" and won't help you setting your
 build system or Makefiles, nor choosing the right CMake options, etc.
 Also, it does not cover all the possible options, nor does it contain
 specific examples for specific architectures. For a concrete example, the
-[instructions for cross-compiling LLVM itself](https://llvm.org/docs/HowToCrossCompileLLVM.html) may be of interest.
+[instructions for cross-compiling LLVM itself](inv:llvm:std:doc#HowToCrossCompileLLVM) may be of interest.
 
 After reading this document, you should be familiar with the main issues
 related to cross-compilation, and what main compiler options Clang provides
@@ -190,4 +190,3 @@ uses hard-float), Clang will pick the `armv7l-linux-gnueabi-ld`
 The same is true if you're compiling for different environments, like
 `gnueabi` and `androideabi`, and might even link and run, but produce
 run-time errors, which are much harder to track down and fix.
-
diff --git a/clang/docs/DebuggingCoroutines.md b/clang/docs/DebuggingCoroutines.md
index 03ea897cb0475..3ab9844184119 100644
--- a/clang/docs/DebuggingCoroutines.md
+++ b/clang/docs/DebuggingCoroutines.md
@@ -600,7 +600,7 @@ gets emitted, but none of them are really interesting regarding debugging
 information.
 
 For more details on the IR representation of coroutines and the relevant
-optimization passes, see [Coroutines in LLVM](https://llvm.org/docs/Coroutines.html).
+optimization passes, see [Coroutines in LLVM](inv:llvm:std:doc#Coroutines).
 
 Emitting debug information inside `CoroSplit` forces us to generate
 insufficient debugging information. Usually, the compiler generates debug
@@ -1264,4 +1264,3 @@ The authors of the Folly libraries wrote a blog post series on how they debug co
 Besides some topics also covered here (stack traces from the debugger), Folly's blog post series also covers
 additional topics, such as capturing async stack traces in performance profiles via eBPF filters
 and printing async stack traces on crashes.
-
diff --git a/clang/docs/HIPSupport.md b/clang/docs/HIPSupport.md
index e2c9443145117..e754459102d19 100644
--- a/clang/docs/HIPSupport.md
+++ b/clang/docs/HIPSupport.md
@@ -730,7 +730,7 @@ We augment the `clang` driver with the following flags:
   point to the folder where the library is installed / built under a
   `/rocprim` subfolder;
 
-The [--offload-arch](https://llvm.org/docs/AMDGPUUsage.html#amdgpu-processors)
+The [--offload-arch](inv:llvm:std:label#amdgpu-processors)
 flag can be used to specify the accelerator for which offload code is to be
 generated.
 
@@ -879,7 +879,7 @@ At the moment, C++ Standard Parallelism Offload is only available for AMD GPUs,
 when the [ROCm](https://rocm.docs.amd.com/en/latest/) stack is used, on the
 Linux operating system. Support is synthesised in the following table:
 
-| [Processor](https://llvm.org/docs/AMDGPUUsage.html#amdgpu-processors) | HMM Mode | Interposition Mode |
+| [Processor](inv:llvm:std:label#amdgpu-processors) | HMM Mode | Interposition Mode |
 | ---------------------------------------------------------------------- | -------- | ------------------ |
 | GCN GFX9 (Vega)                                                        | YES      | YES                |
 | GCN GFX10.1 (RDNA 1)                                                   | *NO*     | YES                |
diff --git a/clang/docs/InternalsManual.md b/clang/docs/InternalsManual.md
index 3b16082b0eeda..8dc9b4ad58d44 100644
--- a/clang/docs/InternalsManual.md
+++ b/clang/docs/InternalsManual.md
@@ -13,7 +13,7 @@ and does not describe any of the clients of the libraries.
 ## LLVM Support Library
 
 The LLVM `libSupport` library provides many underlying libraries and
-[data-structures](https://llvm.org/docs/ProgrammersManual.html), including
+[data-structures](inv:llvm:std:doc#ProgrammersManual), including
 command line option processing, various containers, and a system abstraction
 layer, which is used for file system access.
 
@@ -702,7 +702,7 @@ The clang Driver and library are documented {doc}`here <DriverInternals>`.
 
 Clang supports precompiled headers ({doc}`PCH <PCHInternals>`), which uses a
 serialized representation of Clang's internal data structures, encoded with the
-[LLVM bitstream format](https://llvm.org/docs/BitCodeFormat.html).
+[LLVM bitstream format](inv:llvm:std:doc#BitCodeFormat).
 
 ## The Frontend Library
 
@@ -2920,7 +2920,7 @@ diagnostics purpose, and inject that in the `ConstraintSatisfaction`.
 
 ## The CodeGen Library
 
-CodeGen takes an {ref}`AST <AST>` as input and produces [LLVM IR code](https://llvm.org/docs/LangRef.html) from it.
+CodeGen takes an {ref}`AST <AST>` as input and produces [LLVM IR code](inv:llvm:std:doc#LangRef) from it.
 
 ## How to change Clang
 
@@ -3393,7 +3393,7 @@ are similar.
      to introduce a cleanup. You shouldn't have to deal with
      exception-handling directly.
    - Testing is extremely important in IR generation. Use `clang -cc1
-     -emit-llvm` and [FileCheck](https://llvm.org/docs/CommandGuide/FileCheck.html) to verify that you're
+     -emit-llvm` and [FileCheck](inv:llvm:std:doc#CommandGuide/FileCheck) to verify that you're
      generating the right IR.
 
 6. Teach template instantiation how to cope with your AST node, which requires
@@ -3446,13 +3446,13 @@ the change in behavior. There are four kinds of tests:
   provisions for tests for C++ defect reports are described in
   {ref}`"C++ Defect Report Tests" <cxx-defect-report-tests>` section.
 - AST dump tests: such tests pass printable AST output to the
-  [FileCheck](https://llvm.org/docs/CommandGuide/FileCheck.html) utility,
+  [FileCheck](inv:llvm:std:doc#CommandGuide/FileCheck) utility,
   which check presence of certain patterns (or lack of thereof).
 - LLVM IR tests: in such tests, the LLVM IR output of Clang is checked, which
   is needed in cases when checking diagnostics is not sufficient (e.g. when
   testing exception handling or object lifetime). Such tests pass LLVM IR
   output to the
-  [FileCheck](https://llvm.org/docs/CommandGuide/FileCheck.html) utility,
+  [FileCheck](inv:llvm:std:doc#CommandGuide/FileCheck) utility,
   which check the presence of certain IR patterns (or lack of thereof).
 
 (verifying-diagnostics)=
diff --git a/clang/docs/LLVMExceptionHandlingCodeGen.md b/clang/docs/LLVMExceptionHandlingCodeGen.md
index 4a5720698c10e..a72e30f6b57ea 100644
--- a/clang/docs/LLVMExceptionHandlingCodeGen.md
+++ b/clang/docs/LLVMExceptionHandlingCodeGen.md
@@ -9,7 +9,7 @@ flow patterns used to model normal and exceptional exits, and it outlines how
 the generated IR differs across common ABI models.
 
 For details on the LLVM IR representation of exception handling, see
-[LLVM Exception Handling](https://llvm.org/docs/ExceptionHandling.html).
+[LLVM Exception Handling](inv:llvm:std:doc#ExceptionHandling).
 
 ## Core Model
 
@@ -232,4 +232,3 @@ void f() {
 The above function names and flow are accurate as of LLVM 22.0, but this is
 subject to change as the code evolves, and this document might not be updated to
 reflect the exact functions used.
-
diff --git a/clang/docs/LanguageExtensions.md b/clang/docs/LanguageExtensions.md
index a9d1f54debd2c..dc2d6dca15b76 100644
--- a/clang/docs/LanguageExtensions.md
+++ b/clang/docs/LanguageExtensions.md
@@ -787,16 +787,16 @@ of different sizes and signs is forbidden in binary and ternary builtins.
 | T \_\_builtin_elementwise_canonicalize(T x)    | return the platform specific canonical encoding of a floating-point number                                                                                                                                                                                                                                         | floating point types                         |
 | T \_\_builtin_elementwise_copysign(T x, T y)   | return the magnitude of x with the sign of y.                                                                                                                                                                                                                                                                      | floating point types                         |
 | T \_\_builtin_elementwise_fmod(T x, T y)       | return the floating-point remainder of (x/y) whose sign matches the sign of x.                                                                                                                                                                                                                                     | floating point types                         |
-| T \_\_builtin_elementwise_max(T x, T y)        | return x or y, whichever is larger For floating point types, follows semantics of maxNum in IEEE 754-2008. See [LangRef](http://llvm.org/docs/LangRef.html#i-fminmax-family) for the comparison.                                                                                                                   | integer floating point types (deprecated)    |
-| T \_\_builtin_elementwise_min(T x, T y)        | return x or y, whichever is smaller For floating point types, follows semantics of minNum in IEEE 754-2008. See [LangRef](http://llvm.org/docs/LangRef.html#i-fminmax-family) for the comparison.                                                                                                                  | integer floating point types (deprecated)    |
-| T \_\_builtin_elementwise_maxnum(T x, T y)     | return x or y, whichever is larger. Follows IEEE 754-2008 semantics (maxNum) with +0.0>-0.0. See [LangRef](http://llvm.org/docs/LangRef.html#i-fminmax-family) for the comparison.                                                                                                                                 | floating point types                         |
-| T \_\_builtin_elementwise_minnum(T x, T y)     | return x or y, whichever is smaller. Follows IEEE 754-2008 semantics (minNum) with +0.0>-0.0. See [LangRef](http://llvm.org/docs/LangRef.html#i-fminmax-family) for the comparison.                                                                                                                                | floating point types                         |
+| T \_\_builtin_elementwise_max(T x, T y)        | return x or y, whichever is larger For floating point types, follows semantics of maxNum in IEEE 754-2008. See [LangRef](inv:llvm:std:label#i_fminmax_family) for the comparison.                                                                                                                   | integer floating point types (deprecated)    |
+| T \_\_builtin_elementwise_min(T x, T y)        | return x or y, whichever is smaller For floating point types, follows semantics of minNum in IEEE 754-2008. See [LangRef](inv:llvm:std:label#i_fminmax_family) for the comparison.                                                                                                                  | integer floating point types (deprecated)    |
+| T \_\_builtin_elementwise_maxnum(T x, T y)     | return x or y, whichever is larger. Follows IEEE 754-2008 semantics (maxNum) with +0.0>-0.0. See [LangRef](inv:llvm:std:label#i_fminmax_family) for the comparison.                                                                                                                                 | floating point types                         |
+| T \_\_builtin_elementwise_minnum(T x, T y)     | return x or y, whichever is smaller. Follows IEEE 754-2008 semantics (minNum) with +0.0>-0.0. See [LangRef](inv:llvm:std:label#i_fminmax_family) for the comparison.                                                                                                                                | floating point types                         |
 | T \_\_builtin_elementwise_add_sat(T x, T y)    | return the sum of x and y, clamped to the range of representable values for the signed/unsigned integer type.                                                                                                                                                                                                      | integer types                                |
 | T \_\_builtin_elementwise_sub_sat(T x, T y)    | return the difference of x and y, clamped to the range of representable values for the signed/unsigned integer type.                                                                                                                                                                                               | integer types                                |
-| T \_\_builtin_elementwise_maximum(T x, T y)    | return x or y, whi...
[truncated]

``````````

</details>


https://github.com/llvm/llvm-project/pull/239865


More information about the llvm-branch-commits mailing list