docs: Fix long standing linking antipattern.

Before we learned about :doc:, we used :ref: and put a dummy link at the top of each page. Don't do that anymore. This fixes PR14891 as a special case. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172162 91177308-0d34-0410-b5e6-96231b3b80d8
liug916 · Jan 11, 2013 · a7aec40 · a7aec40
1 parent 52b2373
commit a7aec40
Show file tree

Hide file tree

Showing 44 changed files with 43 additions and 127 deletions.
diff --git a/docs/AliasAnalysis.rst b/docs/AliasAnalysis.rst
@@ -1,5 +1,3 @@
-.. _alias_analysis:
-
 ==================================
 LLVM Alias Analysis Infrastructure
 ==================================

diff --git a/docs/Atomics.rst b/docs/Atomics.rst
@@ -1,5 +1,3 @@
-.. _atomics:
-
 ==============================================
 LLVM Atomic Instructions and Concurrency Guide
 ==============================================

diff --git a/docs/BitCodeFormat.rst b/docs/BitCodeFormat.rst
@@ -1,5 +1,3 @@
-.. _bitcode_format:
-
 .. role:: raw-html(raw)
    :format: html
 

diff --git a/docs/BranchWeightMetadata.rst b/docs/BranchWeightMetadata.rst
@@ -1,5 +1,3 @@
-.. _branch_weight:
-
 ===========================
 LLVM Branch Weight Metadata
 ===========================

diff --git a/docs/Bugpoint.rst b/docs/Bugpoint.rst
@@ -1,5 +1,3 @@
-.. _bugpoint:
-
 ====================================
 LLVM bugpoint tool: design and usage
 ====================================

diff --git a/docs/CMake.rst b/docs/CMake.rst
@@ -1,5 +1,3 @@
-.. _building-with-cmake:
-
 ========================
 Building LLVM with CMake
 ========================

diff --git a/docs/CodeGenerator.rst b/docs/CodeGenerator.rst
@@ -1,5 +1,3 @@
-.. _code_generator:
-
 ==========================================
 The LLVM Target-Independent Code Generator
 ==========================================

diff --git a/docs/CodingStandards.rst b/docs/CodingStandards.rst
@@ -1,5 +1,3 @@
-.. _coding_standards:
-
 =====================
 LLVM Coding Standards
 =====================

diff --git a/docs/CommandGuide/index.rst b/docs/CommandGuide/index.rst
@@ -1,5 +1,3 @@
-.. _commands:
-
 LLVM Command Guide
 ------------------
 

diff --git a/docs/CommandLine.rst b/docs/CommandLine.rst
@@ -1,5 +1,3 @@
-.. _commandline:
-
 ==============================
 CommandLine 2.0 Library Manual
 ==============================

diff --git a/docs/CompilerWriterInfo.rst b/docs/CompilerWriterInfo.rst
@@ -1,5 +1,3 @@
-.. _compiler_writer_info:
-
 ========================================================
 Architecture & Platform Information for Compiler Writers
 ========================================================

diff --git a/docs/DebuggingJITedCode.rst b/docs/DebuggingJITedCode.rst
@@ -1,5 +1,3 @@
-.. _debugging-jited-code:
-
 ==============================
 Debugging JIT-ed Code With GDB
 ==============================

diff --git a/docs/DeveloperPolicy.rst b/docs/DeveloperPolicy.rst
@@ -1,5 +1,3 @@
-.. _developer_policy:
-
 =====================
 LLVM Developer Policy
 =====================

diff --git a/docs/ExceptionHandling.rst b/docs/ExceptionHandling.rst
@@ -1,5 +1,3 @@
-.. _exception_handling:
-
 ==========================
 Exception Handling in LLVM
 ==========================

diff --git a/docs/ExtendingLLVM.rst b/docs/ExtendingLLVM.rst
@@ -1,5 +1,3 @@
-.. _extending_llvm:
-
 ============================================================
 Extending LLVM: Adding instructions, intrinsics, types, etc.
 ============================================================

diff --git a/docs/FAQ.rst b/docs/FAQ.rst
@@ -1,5 +1,3 @@
-.. _faq:
-
 ================================
 Frequently Asked Questions (FAQ)
 ================================

diff --git a/docs/GetElementPtr.rst b/docs/GetElementPtr.rst
@@ -1,5 +1,3 @@
-.. _gep:
-
 =======================================
 The Often Misunderstood GEP Instruction
 =======================================

diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst
@@ -1,5 +1,3 @@
-.. _getting_started:
-
 ====================================
 Getting Started with the LLVM System  
 ====================================

diff --git a/docs/GettingStartedVS.rst b/docs/GettingStartedVS.rst
@@ -1,5 +1,3 @@
-.. _winvs:
-
 ==================================================================
 Getting Started with the LLVM System using Microsoft Visual Studio
 ==================================================================

diff --git a/docs/GoldPlugin.rst b/docs/GoldPlugin.rst
@@ -1,5 +1,3 @@
-.. _gold-plugin:
-
 ====================
 The LLVM gold plugin
 ====================

diff --git a/docs/HowToAddABuilder.rst b/docs/HowToAddABuilder.rst
@@ -1,5 +1,3 @@
-.. _how_to_add_a_builder:
-
 ===================================================================
 How To Add Your Build Configuration To LLVM Buildbot Infrastructure
 ===================================================================

diff --git a/docs/HowToBuildOnARM.rst b/docs/HowToBuildOnARM.rst
@@ -1,5 +1,3 @@
-.. _how_to_build_on_arm:
-
 ===================================================================
 How To Build On ARM
 ===================================================================

diff --git a/docs/HowToReleaseLLVM.rst b/docs/HowToReleaseLLVM.rst
@@ -196,7 +196,7 @@ Build LLVM
 
 Build ``Debug``, ``Release+Asserts``, and ``Release`` versions
 of ``llvm`` on all supported platforms.  Directions to build ``llvm``
-are :ref:`here <getting_started>`.
+are :doc:`here <GettingStarted>`.
 
 Build Clang Binary Distribution
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/HowToSetUpLLVMStyleRTTI.rst b/docs/HowToSetUpLLVMStyleRTTI.rst
@@ -1,5 +1,3 @@
-.. _how-to-set-up-llvm-style-rtti:
-
 ======================================================
 How to set up LLVM-style RTTI for your class hierarchy
 ======================================================

diff --git a/docs/HowToSubmitABug.rst b/docs/HowToSubmitABug.rst
@@ -1,5 +1,3 @@
-.. _how-to-submit-a-bug-report:
-
 ================================
 How to submit an LLVM bug report
 ================================

diff --git a/docs/HowToUseInstrMappings.rst b/docs/HowToUseInstrMappings.rst
@@ -1,5 +1,3 @@
-.. _how_to_use_instruction_mappings:
-
 ===============================
 How To Use Instruction Mappings
 ===============================

diff --git a/docs/Lexicon.rst b/docs/Lexicon.rst
@@ -1,5 +1,3 @@
-.. _lexicon:
-
 ================
 The LLVM Lexicon
 ================

diff --git a/docs/LinkTimeOptimization.rst b/docs/LinkTimeOptimization.rst
@@ -1,5 +1,3 @@
-.. _lto:
-
 ======================================================
 LLVM Link Time Optimization: Design and Implementation
 ======================================================

diff --git a/docs/MakefileGuide.rst b/docs/MakefileGuide.rst
@@ -1,5 +1,3 @@
-.. _makefile_guide:
-
 ===================
 LLVM Makefile Guide
 ===================

diff --git a/docs/MarkedUpDisassembly.rst b/docs/MarkedUpDisassembly.rst
@@ -1,5 +1,3 @@
-.. _marked_up_disassembly:
-
 =======================================
 LLVM's Optional Rich Disassembly Output
 =======================================

diff --git a/docs/Packaging.rst b/docs/Packaging.rst
@@ -1,5 +1,3 @@
-.. _packaging:
-
 ========================
 Advice on Packaging LLVM
 ========================

diff --git a/docs/ProgrammersManual.rst b/docs/ProgrammersManual.rst
@@ -77,8 +77,8 @@ Here are some useful links:
    (even better, get the book)
    <http://www.mindview.net/Books/TICPP/ThinkingInCPP2e.html>`_.
 
-You are also encouraged to take a look at the :ref:`LLVM Coding Standards
-<coding_standards>` guide which focuses on how to write maintainable code more
+You are also encouraged to take a look at the :doc:`LLVM Coding Standards
+<CodingStandards>` guide which focuses on how to write maintainable code more
 than where to put your curly braces.
 
 .. _resources:
@@ -178,8 +178,8 @@ rarely have to include this file directly).
 
 These five templates can be used with any classes, whether they have a v-table
 or not.  If you want to add support for these templates, see the document
-:ref:`How to set up LLVM-style RTTI for your class hierarchy
-<how-to-set-up-llvm-style-rtti>`
+:doc:`How to set up LLVM-style RTTI for your class hierarchy
+<HowToSetUpLLVMStyleRTTI>`
 
 .. _string_apis:
 

diff --git a/docs/Projects.rst b/docs/Projects.rst
@@ -1,5 +1,3 @@
-.. _projects:
-
 ========================
 Creating an LLVM Project
 ========================

diff --git a/docs/SegmentedStacks.rst b/docs/SegmentedStacks.rst
@@ -1,5 +1,3 @@
-.. _segmented_stacks:
-
 ========================
 Segmented Stacks in LLVM
 ========================

diff --git a/docs/TableGenFundamentals.rst b/docs/TableGenFundamentals.rst
@@ -1,5 +1,3 @@
-.. _tablegen:
-
 =====================
 TableGen Fundamentals
 =====================

diff --git a/docs/YamlIO.rst b/docs/YamlIO.rst
@@ -1,5 +1,3 @@
-.. _yamlio:
-
 =====================
 YAML I/O
 =====================

diff --git a/docs/design_and_overview.rst b/docs/design_and_overview.rst
@@ -1,5 +1,3 @@
-.. _design_and_overview:
-
 LLVM Design & Overview
 ======================
 
@@ -31,7 +29,7 @@ LLVM Design & Overview
 
   More details (quite old now).
 
-* :ref:`gep`
+* :doc:`GetElementPtr`
 
   Answers to some very frequent questions about LLVM's most frequently
   misunderstood instruction.
diff --git a/docs/development_process.rst b/docs/development_process.rst
@@ -1,5 +1,3 @@
-.. _development_process:
-
 Development Process Documentation
 =================================
 
@@ -11,7 +9,7 @@ Development Process Documentation
    LLVMBuild
    HowToReleaseLLVM
 
-* :ref:`projects`
+* :doc:`Projects`
 
   How-to guide and templates for new projects that *use* the LLVM
   infrastructure.  The templates (directory organization, Makefiles, and test
@@ -23,7 +21,7 @@ Development Process Documentation
   Describes the LLVMBuild organization and files used by LLVM to specify
   component descriptions.
 
-* :ref:`makefile_guide`
+* :doc:`MakefileGuide`
 
   Describes how the LLVM makefiles work and how to use them.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,3 @@
-.. _contents:
-
 Overview
 ========
 
@@ -18,15 +16,15 @@ targeted at different audiences:
 * **Design & Overview**
 
  Several introductory papers and presentations are available at
- :ref:`design_and_overview`.
+ :doc:`design_and_overview`.
 
 * **Publications**
 
  The list of `publications <http://llvm.org/pubs>`_ based on LLVM.
 
 * **User Guides**
 
- Those new to the LLVM system should first visit the :ref:`userguides`.
+ Those new to the LLVM system should first visit the :doc:`userguides`.
 
  NOTE: If you are a user who is only interested in using LLVM-based
  compilers, you should look into `Clang <http://clang.llvm.org>`_ or
@@ -37,21 +35,21 @@ targeted at different audiences:
 * **API Clients**
 
  Developers of applications which use LLVM as a library should visit the
- :ref:`programming`.
+ :doc:`programming`.
 
 * **Subsystems**
 
  API clients and LLVM developers may be interested in the
- :ref:`subsystems` documentation.
+ :doc:`subsystems` documentation.
 
 * **Development Process**
 
  Additional documentation on the LLVM project can be found at
- :ref:`development_process`.
+ :doc:`development_process`.
 
 * **Mailing Lists**
 
- For more information, consider consulting the LLVM :ref:`mailing_lists`.
+ For more information, consider consulting the LLVM :doc:`mailing_lists`.
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/mailing_lists.rst b/docs/mailing_lists.rst
@@ -1,5 +1,3 @@
-.. _mailing_lists:
-
 Mailing Lists
 =============
 

diff --git a/docs/programming.rst b/docs/programming.rst
@@ -1,5 +1,3 @@
-.. _programming:
-
 Programming Documentation
 =========================
 
@@ -14,12 +12,12 @@ Programming Documentation
    HowToSetUpLLVMStyleRTTI
    ProgrammersManual
 
-* `LLVM Language Reference Manual <LangRef.html>`_
+* :doc:`LLVM Language Reference Manual <LangRef>`
 
   Defines the LLVM intermediate representation and the assembly form of the
   different nodes.
 
-* :ref:`atomics`
+* :doc:`Atomics`
 
   Information about LLVM's concurrency model.
 
@@ -28,11 +26,11 @@ Programming Documentation
   Introduction to the general layout of the LLVM sourcebase, important classes
   and APIs, and some tips & tricks.
 
-* :ref:`commandline`
+* :doc:`CommandLine`
 
   Provides information on using the command line parsing library.
 
-* :ref:`coding_standards`
+* :doc:`CodingStandards`
 
   Details the LLVM coding standards and provides useful information on writing
   efficient C++ code.
@@ -42,7 +40,7 @@ Programming Documentation
   How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
   class hierarchy.
 
-* :ref:`extending_llvm`
+* :doc:`ExtendingLLVM`
 
   Look here to see how to add instructions and intrinsics to LLVM.
 
@@ -53,6 +51,6 @@ Programming Documentation
 
 * `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
 
-* :ref:`compiler_writer_info`
+* :doc:`CompilerWriterInfo`
 
   A list of helpful links for compiler writers.