[clang] [clang][docs] Use doc links to HLSL/ResourceTypes in AttrDocs.td (PR #227407)

Nico Weber via cfe-commits cfe-commits at lists.llvm.org
Tue Sep 29 10:56:33 PDT 2026


https://github.com/nico created https://github.com/llvm/llvm-project/pull/227407

#222504 made the docs build warn about absolute links to pages of the same Sphinx project, and the docs build turns warnings into errors. The HLSL resource attribute docs added in #213346 linked to https://clang.llvm.org/docs/HLSL/ResourceTypes.html, which broke the clang docs build (docs-clang-html, docs-clang-man). Use the {doc} role instead, like the rest of AttrDocs.td.

>From 332f437351b34eb9160eaade63c3d731e60c2f4d Mon Sep 17 00:00:00 2001
From: Nico Weber <thakis at chromium.org>
Date: Tue, 29 Sep 2026 10:54:46 -0700
Subject: [PATCH] [clang][docs] Use doc links to HLSL/ResourceTypes in
 AttrDocs.td

#222504 made the docs build warn about absolute links to pages of the
same Sphinx project, and the docs build turns warnings into errors. The
HLSL resource attribute docs added in #213346 linked to
https://clang.llvm.org/docs/HLSL/ResourceTypes.html, which broke the clang
docs build (docs-clang-html, docs-clang-man). Use the {doc} role instead,
like the rest of AttrDocs.td.
---
 clang/include/clang/Basic/AttrDocs.td | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td
index 6c58e4cfc114d..0ab1429ff09d6 100644
--- a/clang/include/clang/Basic/AttrDocs.td
+++ b/clang/include/clang/Basic/AttrDocs.td
@@ -9266,7 +9266,7 @@ declaring it to be an SRV, UAV, CBuffer, or Sampler resource.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 
@@ -9279,7 +9279,7 @@ resource to have Unknown, 1D, 2D, 3D, or Cube dimension.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 
@@ -9291,7 +9291,7 @@ represented by a member variable of type `__hlsl_resource_t`.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 
@@ -9303,7 +9303,7 @@ by a member variable of type `__hlsl_resource_t` has raw buffer semantics.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 
@@ -9315,7 +9315,7 @@ by a member variable of type `__hlsl_resource_t` has array dimensions.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 
@@ -9327,7 +9327,7 @@ by a member variable of type `__hlsl_resource_t` is multisampled.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 
@@ -9339,7 +9339,7 @@ a member variable of type `__hlsl_resource_t` is a rasterizer ordered view.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 
@@ -9351,7 +9351,7 @@ by a member variable of type `__hlsl_resource_t` is a counter buffer.
 
 This attribute is only valid for resource handles, and is an implementation
 detail of clang's HLSL implementation. For more information see
-[HLSL Resource Types](https://clang.llvm.org/docs/HLSL/ResourceTypes.html).
+{doc}`HLSL Resource Types <HLSL/ResourceTypes>`.
   }];
 }
 



More information about the cfe-commits mailing list