[llvm] [Docs] Fix broken LLVM doc pages (PR #68631)

Aiden Grossman via llvm-commits llvm-commits at lists.llvm.org
Mon Oct 9 14:25:10 PDT 2023


https://github.com/boomanaiden154 created https://github.com/llvm/llvm-project/pull/68631

These pages have warnings due to the links not being moved during the myst transition and maybe some breakages afterwards. This causes the docs build to fail as warnings are treated as errors by default. This patch fixes these issues for llvm/*.

>From 1b0b7fb0bfcbf34bbcdd64a5c2ea31fb0a45cb10 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Mon, 9 Oct 2023 21:20:28 +0000
Subject: [PATCH] [Docs] Fix broken LLVM doc pages

These pages have warnings due to the links not being moved during the
myst transition and maybe some breakages afterwards. This causes the
docs build to fail as warnings are treated as errors by default. This
patch fixes these issues for llvm/*.
---
 llvm/docs/GitRepositoryPolicy.md        | 2 +-
 llvm/docs/InstrRefDebugInfo.md          | 2 +-
 llvm/docs/MarkdownQuickstartTemplate.md | 2 +-
 llvm/docs/PointerAuth.md                | 6 ++----
 4 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/llvm/docs/GitRepositoryPolicy.md b/llvm/docs/GitRepositoryPolicy.md
index f6442e4e11c2aad..f2449251a24c315 100644
--- a/llvm/docs/GitRepositoryPolicy.md
+++ b/llvm/docs/GitRepositoryPolicy.md
@@ -20,7 +20,7 @@ Requirements for *new* repositories as part of the
 
 If you want to integrate your project as part of the Monorepo, please take a
 look at the
-[Developer Policy](DeveloperPolicy.html#adding-an-established-project-to-the-llvm-monorepo>).
+[Developer Policy](project:DeveloperPolicy.rst#Adding an Established Project To the LLVM Monorepo).
 
 To request a new repository, please create an issue with the
 [Infrastructure Working Group](https://github.com/llvm/llvm-iwg/issues).
diff --git a/llvm/docs/InstrRefDebugInfo.md b/llvm/docs/InstrRefDebugInfo.md
index e0180ea11eb8a57..3917989e4026dfe 100644
--- a/llvm/docs/InstrRefDebugInfo.md
+++ b/llvm/docs/InstrRefDebugInfo.md
@@ -191,4 +191,4 @@ instruction number of any cloned instruction, to avoid duplicate numbers
 appearing to `LiveDebugValues`. Dealing with duplicated instructions is a
 natural extension to instruction referencing that's currently unimplemented.
 
-[LiveDebugValues]: SourceLevelDebugging.html#livedebugvalues-expansion-of-variable-locations
+[LiveDebugValues]: project:SourceLevelDebugging.rst#LiveDebugValues expansion of variable locations
diff --git a/llvm/docs/MarkdownQuickstartTemplate.md b/llvm/docs/MarkdownQuickstartTemplate.md
index add5985d5b40bb2..8b03b4e26d419f8 100644
--- a/llvm/docs/MarkdownQuickstartTemplate.md
+++ b/llvm/docs/MarkdownQuickstartTemplate.md
@@ -158,4 +158,4 @@ integration documentation can be found in the [myst-parser docs].
 
 ## Generating the documentation
 
-see [Sphinx Quickstart Template](SphinxQuickstartTemplate.html#generating-the-documentation)
+see [Sphinx Quickstart Template](project:SphinxQuickstartTemplate.rst#Generating the documentation)
diff --git a/llvm/docs/PointerAuth.md b/llvm/docs/PointerAuth.md
index c5f195faaa459db..41266b43bc29ab7 100644
--- a/llvm/docs/PointerAuth.md
+++ b/llvm/docs/PointerAuth.md
@@ -303,8 +303,7 @@ instructions as such:
 
 #### Assembly Representation
 
-At the assembly level,
-[Authenticated Relocations](#authenticated-global-relocation) are represented
+At the assembly level, authenticated relocations are represented
 using the `@AUTH` modifier:
 
 ```asm
@@ -328,8 +327,7 @@ For example:
 
 #### ELF Object File Representation
 
-At the object file level,
-[Authenticated Relocations](#authenticated-global-relocation) are represented
+At the object file level, authenticated relocations are represented
 using the `R_AARCH64_AUTH_ABS64` relocation kind (with value `0xE100`).
 
 The signing schema is encoded in the place of relocation to be applied



More information about the llvm-commits mailing list