mirror of
https://github.com/RPCS3/llvm.git
synced 2024-11-24 12:20:00 +00:00
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
This commit is contained in:
Sean Silva
parent
52b23731d6
commit
a7aec400a7
@ -1,5 +1,3 @@
|
||||
.. _alias_analysis:
|
||||
|
||||
==================================
|
||||
LLVM Alias Analysis Infrastructure
|
||||
==================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _atomics:
|
||||
|
||||
==============================================
|
||||
LLVM Atomic Instructions and Concurrency Guide
|
||||
==============================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _bitcode_format:
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _branch_weight:
|
||||
|
||||
===========================
|
||||
LLVM Branch Weight Metadata
|
||||
===========================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _bugpoint:
|
||||
|
||||
====================================
|
||||
LLVM bugpoint tool: design and usage
|
||||
====================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _building-with-cmake:
|
||||
|
||||
========================
|
||||
Building LLVM with CMake
|
||||
========================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _code_generator:
|
||||
|
||||
==========================================
|
||||
The LLVM Target-Independent Code Generator
|
||||
==========================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _coding_standards:
|
||||
|
||||
=====================
|
||||
LLVM Coding Standards
|
||||
=====================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _commands:
|
||||
|
||||
LLVM Command Guide
|
||||
------------------
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _commandline:
|
||||
|
||||
==============================
|
||||
CommandLine 2.0 Library Manual
|
||||
==============================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _compiler_writer_info:
|
||||
|
||||
========================================================
|
||||
Architecture & Platform Information for Compiler Writers
|
||||
========================================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _debugging-jited-code:
|
||||
|
||||
==============================
|
||||
Debugging JIT-ed Code With GDB
|
||||
==============================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _developer_policy:
|
||||
|
||||
=====================
|
||||
LLVM Developer Policy
|
||||
=====================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _exception_handling:
|
||||
|
||||
==========================
|
||||
Exception Handling in LLVM
|
||||
==========================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _extending_llvm:
|
||||
|
||||
============================================================
|
||||
Extending LLVM: Adding instructions, intrinsics, types, etc.
|
||||
============================================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _faq:
|
||||
|
||||
================================
|
||||
Frequently Asked Questions (FAQ)
|
||||
================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _gep:
|
||||
|
||||
=======================================
|
||||
The Often Misunderstood GEP Instruction
|
||||
=======================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _getting_started:
|
||||
|
||||
====================================
|
||||
Getting Started with the LLVM System
|
||||
====================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _winvs:
|
||||
|
||||
==================================================================
|
||||
Getting Started with the LLVM System using Microsoft Visual Studio
|
||||
==================================================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _gold-plugin:
|
||||
|
||||
====================
|
||||
The LLVM gold plugin
|
||||
====================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _how_to_add_a_builder:
|
||||
|
||||
===================================================================
|
||||
How To Add Your Build Configuration To LLVM Buildbot Infrastructure
|
||||
===================================================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _how_to_build_on_arm:
|
||||
|
||||
===================================================================
|
||||
How To Build On ARM
|
||||
===================================================================
|
||||
|
||||
@ -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
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _how-to-set-up-llvm-style-rtti:
|
||||
|
||||
======================================================
|
||||
How to set up LLVM-style RTTI for your class hierarchy
|
||||
======================================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _how-to-submit-a-bug-report:
|
||||
|
||||
================================
|
||||
How to submit an LLVM bug report
|
||||
================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _how_to_use_instruction_mappings:
|
||||
|
||||
===============================
|
||||
How To Use Instruction Mappings
|
||||
===============================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _lexicon:
|
||||
|
||||
================
|
||||
The LLVM Lexicon
|
||||
================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _lto:
|
||||
|
||||
======================================================
|
||||
LLVM Link Time Optimization: Design and Implementation
|
||||
======================================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _makefile_guide:
|
||||
|
||||
===================
|
||||
LLVM Makefile Guide
|
||||
===================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _marked_up_disassembly:
|
||||
|
||||
=======================================
|
||||
LLVM's Optional Rich Disassembly Output
|
||||
=======================================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _packaging:
|
||||
|
||||
========================
|
||||
Advice on Packaging LLVM
|
||||
========================
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _projects:
|
||||
|
||||
========================
|
||||
Creating an LLVM Project
|
||||
========================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _segmented_stacks:
|
||||
|
||||
========================
|
||||
Segmented Stacks in LLVM
|
||||
========================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _tablegen:
|
||||
|
||||
=====================
|
||||
TableGen Fundamentals
|
||||
=====================
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _yamlio:
|
||||
|
||||
=====================
|
||||
YAML I/O
|
||||
=====================
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _mailing_lists:
|
||||
|
||||
Mailing Lists
|
||||
=============
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -1,5 +1,3 @@
|
||||
.. _yaml2obj:
|
||||
|
||||
yaml2obj
|
||||
========
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user