docs: Fix long standing linking antipattern.
authorSean Silva <silvas@purdue.edu>
Fri, 11 Jan 2013 02:28:08 +0000 (02:28 +0000)
committerSean Silva <silvas@purdue.edu>
Fri, 11 Jan 2013 02:28:08 +0000 (02:28 +0000)
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

44 files changed:
docs/AliasAnalysis.rst
docs/Atomics.rst
docs/BitCodeFormat.rst
docs/BranchWeightMetadata.rst
docs/Bugpoint.rst
docs/CMake.rst
docs/CodeGenerator.rst
docs/CodingStandards.rst
docs/CommandGuide/index.rst
docs/CommandLine.rst
docs/CompilerWriterInfo.rst
docs/DebuggingJITedCode.rst
docs/DeveloperPolicy.rst
docs/ExceptionHandling.rst
docs/ExtendingLLVM.rst
docs/FAQ.rst
docs/GetElementPtr.rst
docs/GettingStarted.rst
docs/GettingStartedVS.rst
docs/GoldPlugin.rst
docs/HowToAddABuilder.rst
docs/HowToBuildOnARM.rst
docs/HowToReleaseLLVM.rst
docs/HowToSetUpLLVMStyleRTTI.rst
docs/HowToSubmitABug.rst
docs/HowToUseInstrMappings.rst
docs/Lexicon.rst
docs/LinkTimeOptimization.rst
docs/MakefileGuide.rst
docs/MarkedUpDisassembly.rst
docs/Packaging.rst
docs/ProgrammersManual.rst
docs/Projects.rst
docs/SegmentedStacks.rst
docs/TableGenFundamentals.rst
docs/YamlIO.rst
docs/design_and_overview.rst
docs/development_process.rst
docs/index.rst
docs/mailing_lists.rst
docs/programming.rst
docs/subsystems.rst
docs/userguides.rst
docs/yaml2obj.rst

index 54b4a4a746500e90f92a854cfa68e3ac44e8c281..712d57d14b12b4398b7410bdd83c889cfa44a81d 100644 (file)
@@ -1,5 +1,3 @@
-.. _alias_analysis:
-
 ==================================
 LLVM Alias Analysis Infrastructure
 ==================================
index 1bca53e2b17ecd5dcb90ed95ff33c6714a8c1f9f..705d73fbaba43c62b9dbd80bedd20e3cd77bea30 100644 (file)
@@ -1,5 +1,3 @@
-.. _atomics:
-
 ==============================================
 LLVM Atomic Instructions and Concurrency Guide
 ==============================================
index 333e79b8643618d626fee172241b745c31b09d3e..c83b6c1801cd403980c0d6063dd40b7b8c4db23b 100644 (file)
@@ -1,5 +1,3 @@
-.. _bitcode_format:
-
 .. role:: raw-html(raw)
    :format: html
 
index 2667ce3589cb65987488c499cacb58ec9a096f6d..71ecd34c82166e586c857c0c3633e16e1794ebe4 100644 (file)
@@ -1,5 +1,3 @@
-.. _branch_weight:
-
 ===========================
 LLVM Branch Weight Metadata
 ===========================
index 047129f4106c41f9901dd60a94e7b293a1cf222c..1a5fc8c0276401287e30388987e469b35294adc5 100644 (file)
@@ -1,5 +1,3 @@
-.. _bugpoint:
-
 ====================================
 LLVM bugpoint tool: design and usage
 ====================================
index f89578863c542445d883578e7c47e8b89b5379a3..6eab04b9706b9424766dd715fe26634c93e10e0c 100644 (file)
@@ -1,5 +1,3 @@
-.. _building-with-cmake:
-
 ========================
 Building LLVM with CMake
 ========================
index ce23667eb3e31a1acf23c9a41598140eed35f5c7..78f7287befc3bb21e925bc129444f9f0c17034dd 100644 (file)
@@ -1,5 +1,3 @@
-.. _code_generator:
-
 ==========================================
 The LLVM Target-Independent Code Generator
 ==========================================
index 8003c12497b83d783b1e86f40dc64d59f6fba490..6377763d8dbd6fe72f157e8821ad2d8bcea00fcb 100644 (file)
@@ -1,5 +1,3 @@
-.. _coding_standards:
-
 =====================
 LLVM Coding Standards
 =====================
index 73a4835dd7a19d5c27fde8a060d3ca2ae2c22dd0..9bfa9645d8bf2cfe9efef3202038d7e469a5f211 100644 (file)
@@ -1,5 +1,3 @@
-.. _commands:
-
 LLVM Command Guide
 ------------------
 
index fe5819abeb2279f11534ad9c40b415261805fbd5..073958b16bad2a3b22b4d00436c4a62ba0c307fc 100644 (file)
@@ -1,5 +1,3 @@
-.. _commandline:
-
 ==============================
 CommandLine 2.0 Library Manual
 ==============================
index f21491994fe1febe4dc641904515a3faa2626c7e..0744656f03b179fa3113147c7a50abc82c57688d 100644 (file)
@@ -1,5 +1,3 @@
-.. _compiler_writer_info:
-
 ========================================================
 Architecture & Platform Information for Compiler Writers
 ========================================================
index 53b2e89e5e26497235f172363b15e4e14132c879..d6101d51003408ad18fdc440d050c378318e5888 100644 (file)
@@ -1,5 +1,3 @@
-.. _debugging-jited-code:
-
 ==============================
 Debugging JIT-ed Code With GDB
 ==============================
index 925e769b860d2c387042f993bf3f1b73c84d3a41..43bdc8598531b5f1481a5c0ffa6dba45d08e75ad 100644 (file)
@@ -1,5 +1,3 @@
-.. _developer_policy:
-
 =====================
 LLVM Developer Policy
 =====================
index 190f18261da0cf6008f58d0b946692db291ba931..47fecd38e48e4be3939ea52f96c9b7ae7f2b5b06 100644 (file)
@@ -1,5 +1,3 @@
-.. _exception_handling:
-
 ==========================
 Exception Handling in LLVM
 ==========================
index 6df08eee985a34d0ca53c165d1cb73d2d664dfb9..3d8e9ee79a46bbefdabb8de43b240c318cbb2021 100644 (file)
@@ -1,5 +1,3 @@
-.. _extending_llvm:
-
 ============================================================
 Extending LLVM: Adding instructions, intrinsics, types, etc.
 ============================================================
index b4c6261c65d8010ff215669691b440b544458a58..e4ab2c18f748073ae79d060767e51c7652875677 100644 (file)
@@ -1,5 +1,3 @@
-.. _faq:
-
 ================================
 Frequently Asked Questions (FAQ)
 ================================
index 3b57d78cf1ef43eb37daddb05f91b14aa76ec105..306a2a87effd13c85a857d77ef54ab5db52dd814 100644 (file)
@@ -1,5 +1,3 @@
-.. _gep:
-
 =======================================
 The Often Misunderstood GEP Instruction
 =======================================
index 322c3558a5ff2b065b9d35517c462d96903032e8..8503396a3ba80c5a3bdbf2b591fd345242abb94b 100644 (file)
@@ -1,5 +1,3 @@
-.. _getting_started:
-
 ====================================
 Getting Started with the LLVM System  
 ====================================
index 35f97f04b9d50db115fd6718167453496dea5d63..4c80f2c57bfad8538146132c9ef935312cda807d 100644 (file)
@@ -1,5 +1,3 @@
-.. _winvs:
-
 ==================================================================
 Getting Started with the LLVM System using Microsoft Visual Studio
 ==================================================================
index 722a9a1bb06f61c1c46321b762da43984fcbe024..17bbeb8ba9f85d4bafa35e6f351568d10b548f78 100644 (file)
@@ -1,5 +1,3 @@
-.. _gold-plugin:
-
 ====================
 The LLVM gold plugin
 ====================
index f472f74e37cc14c9a95b4649549677c279a38678..893f12d19d55d53f5d32b853422390ce01d74497 100644 (file)
@@ -1,5 +1,3 @@
-.. _how_to_add_a_builder:
-
 ===================================================================
 How To Add Your Build Configuration To LLVM Buildbot Infrastructure
 ===================================================================
index 4e256395930e49dbb70a88e517fe0f15be1e76a2..13de7d1b44709bab6506aaf3b7dcf6460919eb6b 100644 (file)
@@ -1,5 +1,3 @@
-.. _how_to_build_on_arm:
-
 ===================================================================
 How To Build On ARM
 ===================================================================
index 7bd5e14ff8343af5616cef7a4b97b53147d89a6a..208b9b7632014a4df3bf015c9c0ed5b02eff4466 100644 (file)
@@ -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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
index a2e46b3d7f213767911f3f451461f7987ca561b7..b906b25621d63f390cb0bc45676eccfc2f4a6ff4 100644 (file)
@@ -1,5 +1,3 @@
-.. _how-to-set-up-llvm-style-rtti:
-
 ======================================================
 How to set up LLVM-style RTTI for your class hierarchy
 ======================================================
index 2f852ed987f6d508a3c0c992ff8f1a7463c4eff6..45be2826b301d16693550c799c1d51251dc75e38 100644 (file)
@@ -1,5 +1,3 @@
-.. _how-to-submit-a-bug-report:
-
 ================================
 How to submit an LLVM bug report
 ================================
index d566eba3266f0d9024ae500f2dd436f850143499..8a3e7c8d726dc41f3bc50b3523ef6190924d9951 100644 (file)
@@ -1,5 +1,3 @@
-.. _how_to_use_instruction_mappings:
-
 ===============================
 How To Use Instruction Mappings
 ===============================
index cbe15852262f77dcc3e2512b254f13be182b845a..10821f471296ce0edb4aafe8399edfc2399bf12d 100644 (file)
@@ -1,5 +1,3 @@
-.. _lexicon:
-
 ================
 The LLVM Lexicon
 ================
index 822196ccf47a7d6a6ba810f776e71a3843b40d8b..c15abd325ed03c989cd9bddf887fcc77dbe76155 100644 (file)
@@ -1,5 +1,3 @@
-.. _lto:
-
 ======================================================
 LLVM Link Time Optimization: Design and Implementation
 ======================================================
index 4988fe664d79757ea50d54f5742c1a3380174f24..6e8cce9c5315f6d117bb7c35cdcdabf7b5343059 100644 (file)
@@ -1,5 +1,3 @@
-.. _makefile_guide:
-
 ===================
 LLVM Makefile Guide
 ===================
index e1282e102ebefbbac93881d03c70d84fe73d87a1..cc4dbc817e085726a57d3f74ee209330b215afa9 100644 (file)
@@ -1,5 +1,3 @@
-.. _marked_up_disassembly:
-
 =======================================
 LLVM's Optional Rich Disassembly Output
 =======================================
index 6e74158d7213763229e0e0155e1979fcfe4653e5..7c2dc956128ea01839a315bd04b2bade87943fdf 100644 (file)
@@ -1,5 +1,3 @@
-.. _packaging:
-
 ========================
 Advice on Packaging LLVM
 ========================
index 5e443c84a45096b2a0477b5005195d58532b1e92..fefe497eb303a43583a1856a76330f9129545e47 100644 (file)
@@ -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:
 
index c5d03d33a07f15e845050e50d679bf3ee0921804..3a5744aedb479fc1203dbc9338d9a382abf11c8b 100644 (file)
@@ -1,5 +1,3 @@
-.. _projects:
-
 ========================
 Creating an LLVM Project
 ========================
index f97d62abda046ea1e3fd4e2b5290960d2c38c15d..e44ce42313cbefb4f8d543936338fa5f876bda13 100644 (file)
@@ -1,5 +1,3 @@
-.. _segmented_stacks:
-
 ========================
 Segmented Stacks in LLVM
 ========================
index 73bcd66a60cb1eebfa88329b5af958245245e58e..526795f53d0b4c0e64b070315a1455bf50b33474 100644 (file)
@@ -1,5 +1,3 @@
-.. _tablegen:
-
 =====================
 TableGen Fundamentals
 =====================
index b009b67ef4db3736886e55efd0b5e67339ab0a2d..f87f61f44a0fc7c0ee3dd6ffb9dfa4bfcf0045a4 100644 (file)
@@ -1,5 +1,3 @@
-.. _yamlio:
-
 =====================
 YAML I/O
 =====================
index 4b1d627380ca546d110d3e1a2cea6861624f7327..2fc377f3aa49767f0beca9bc086d7c7bcc59f536 100644 (file)
@@ -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.
index ecd4c6a6167845b35a921951770340cc5ece0134..86d611cab99b5ef00e03b4a394d9ca9ec4366c2c 100644 (file)
@@ -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.
 
index d406b525744008073c9c55c0f8b9f277467487c6..6aefc86b10ad5bc905f80bf00d6cbf9d924aebd7 100644 (file)
@@ -1,5 +1,3 @@
-.. _contents:
-
 Overview
 ========
 
@@ -18,7 +16,7 @@ targeted at different audiences:
 * **Design & Overview**
 
  Several introductory papers and presentations are available at
- :ref:`design_and_overview`.
+ :doc:`design_and_overview`.
 
 * **Publications**
 
@@ -26,7 +24,7 @@ targeted at different audiences:
 
 * **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
index 106f1da48f8910409be7c228bd89869430cd3bd2..d6ac9c730bd2923e06a511814478dd6a30d5997e 100644 (file)
@@ -1,5 +1,3 @@
-.. _mailing_lists:
-
 Mailing Lists
 =============
 
index 3fea6ed4277beca2d09d2c3647339e158a583a0d..aa51130533b5373bae28b6c658ca7fe6192be2b3 100644 (file)
@@ -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.
index 505c573075a5c555a93730588f5c8441c097c9d4..7430c82f1ceab2895ebde8626ec6e1129d800e62 100644 (file)
@@ -1,5 +1,3 @@
-.. _subsystems:
-
 Subsystem Documentation
 =======================
 
@@ -34,18 +32,18 @@ Subsystem Documentation
 
    Information on how to write LLVM backends for machine targets.
 
-* :ref:`code_generator`
+* :doc:`CodeGenerator`
 
    The design and implementation of the LLVM code generator.  Useful if you are
    working on retargetting LLVM to a new architecture, designing a new codegen
    pass, or enhancing existing components.
     
-* :ref:`tablegen`
+* :doc:`TableGenFundamentals`
 
    Describes the TableGen tool, which is used heavily by the LLVM code
    generator.
     
-* :ref:`alias_analysis`
+* :doc:`AliasAnalysis`
     
    Information on how to write a new alias analysis implementation or how to
    use existing analyses.
@@ -64,17 +62,17 @@ Subsystem Documentation
     
    This document describes the current status of vectorization in LLVM.
     
-* :ref:`exception_handling`
+* :doc:`ExceptionHandling`
     
    This document describes the design and implementation of exception handling
    in LLVM.
     
-* :ref:`bugpoint`
+* :doc:`Bugpoint`
     
    Automatic bug finder and test-case reducer description and usage
    information.
     
-* :ref:`bitcode_format`
+* :doc:`BitCodeFormat`
     
    This describes the file format and encoding used for LLVM "bc" files.
     
@@ -83,28 +81,28 @@ Subsystem Documentation
    This document describes the LLVM System Library (``lib/System``) and
    how to keep LLVM source code portable
     
-* :ref:`lto`
+* :doc:`LinkTimeOptimization`
     
    This document describes the interface between LLVM intermodular optimizer
    and the linker and its design
     
-* :ref:`gold-plugin`
+* :doc:`GoldPlugin`
     
    How to build your programs with link-time optimization on Linux.
     
-* :ref:`debugging-jited-code`
+* :doc:`DebuggingJITedCode`
     
    How to debug JITed code with GDB.
     
-* :ref:`branch_weight`
+* :doc:`BranchWeightMetadata`
     
    Provides information about Branch Prediction Information.
 
-* :ref:`segmented_stacks`
+* :doc:`SegmentedStacks`
 
    This document describes segmented stacks and how they are used in LLVM.
 
-* :ref:`marked_up_disassembly`
+* :doc:`MarkedUpDisassembly`
 
    This document describes the optional rich disassembly output syntax.
 
index c0a4356b0e151685dbe0bf73b2e1dea2da19f117..e7e4518afcfec931645f368b0118c6ecd0acc0c7 100644 (file)
@@ -1,5 +1,3 @@
-.. _userguides:
-
 User Guides
 ===========
 
@@ -26,18 +24,18 @@ User Guides
    Passes
    YamlIO
 
-* :ref:`getting_started`
+* :doc:`GettingStarted`
     
    Discusses how to get up and running quickly with the LLVM infrastructure.
    Everything from unpacking and compilation of the distribution to execution
    of some tools.
     
-* :ref:`building-with-cmake`
+* :doc:`CMake`
 
    An addendum to the main Getting Started guide for those using the `CMake
    build system <http://www.cmake.org>`_.
 
-* :ref:`how_to_build_on_arm`
+* :doc:`HowToBuildOnARM`
 
    Notes on building and testing LLVM/Clang on ARM.
 
@@ -51,11 +49,11 @@ User Guides
    Tutorials about using LLVM. Includes a tutorial about making a custom
    language with LLVM.
 
-* :ref:`developer_policy`
+* :doc:`DeveloperPolicy`
 
    The LLVM project's policy towards developers and their contributions.
 
-* :ref:`LLVM Command Guide <commands>`
+* :doc:`LLVM Command Guide <CommandGuide/index>`
 
    A reference manual for the LLVM command line utilities ("man" pages for LLVM
    tools).
@@ -64,7 +62,7 @@ User Guides
 
    A list of optimizations and analyses implemented in LLVM.
 
-* :ref:`faq`
+* :doc:`FAQ`
 
    A list of common questions and problems and their solutions.
     
@@ -72,7 +70,7 @@ User Guides
 
    This describes new features, known bugs, and other limitations.
 
-* :ref:`how-to-submit-a-bug-report`
+* :doc:`HowToSubmitABug`
     
    Instructions for properly submitting information about any bugs you run into
    in the LLVM system.
@@ -89,19 +87,19 @@ User Guides
 
    Instructions for building the clang front-end from source.
     
-* :ref:`packaging`
+* :doc:`Packaging`
 
    Advice on packaging LLVM into a distribution.
     
-* :ref:`lexicon`
+* :doc:`Lexicon`
 
    Definition of acronyms, terms and concepts used in LLVM.
 
-* :ref:`how_to_add_a_builder`
+* :doc:`HowToAddABuilder`
 
    Instructions for adding new builder to LLVM buildbot master.
     
-* :ref:`yamlio`
+* :doc:`YamlIO`
 
    A reference guide for using LLVM's YAML I/O library.
 
index d051e7e22c00e127d11c52e8fc38a866b439d0b6..b269806e06f63fb56a41db80a05f4bc0d38384d6 100644 (file)
@@ -1,5 +1,3 @@
-.. _yaml2obj:
-
 yaml2obj
 ========