llvm.org GIT mirror llvm / a7aec40
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 Sean Silva 6 years ago
44 changed file(s) with 43 addition(s) and 127 deletion(s). Raw diff Collapse all Expand all
None .. _alias_analysis:
1
2 ==================================
31 LLVM Alias Analysis Infrastructure
42 ==================================
None .. _atomics:
1
2 ==============================================
31 LLVM Atomic Instructions and Concurrency Guide
42 ==============================================
None .. _bitcode_format:
1
2 .. role:: raw-html(raw)
31 :format: html
42
None .. _branch_weight:
1
2 ===========================
31 LLVM Branch Weight Metadata
42 ===========================
None .. _bugpoint:
1
2 ====================================
31 LLVM bugpoint tool: design and usage
42 ====================================
None .. _building-with-cmake:
1
2 ========================
31 Building LLVM with CMake
42 ========================
None .. _code_generator:
1
2 ==========================================
31 The LLVM Target-Independent Code Generator
42 ==========================================
None .. _coding_standards:
1
2 =====================
31 LLVM Coding Standards
42 =====================
None .. _commands:
1
2 LLVM Command Guide
31 ------------------
42
None .. _commandline:
1
2 ==============================
31 CommandLine 2.0 Library Manual
42 ==============================
None .. _compiler_writer_info:
1
2 ========================================================
31 Architecture & Platform Information for Compiler Writers
42 ========================================================
None .. _debugging-jited-code:
1
2 ==============================
31 Debugging JIT-ed Code With GDB
42 ==============================
None .. _developer_policy:
1
2 =====================
31 LLVM Developer Policy
42 =====================
None .. _exception_handling:
1
2 ==========================
31 Exception Handling in LLVM
42 ==========================
None .. _extending_llvm:
1
2 ============================================================
31 Extending LLVM: Adding instructions, intrinsics, types, etc.
42 ============================================================
None .. _faq:
1
2 ================================
31 Frequently Asked Questions (FAQ)
42 ================================
None .. _gep:
1
2 =======================================
31 The Often Misunderstood GEP Instruction
42 =======================================
None .. _getting_started:
1
2 ====================================
31 Getting Started with the LLVM System
42 ====================================
None .. _winvs:
1
2 ==================================================================
31 Getting Started with the LLVM System using Microsoft Visual Studio
42 ==================================================================
None .. _gold-plugin:
1
2 ====================
31 The LLVM gold plugin
42 ====================
None .. _how_to_add_a_builder:
1
2 ===================================================================
31 How To Add Your Build Configuration To LLVM Buildbot Infrastructure
42 ===================================================================
None .. _how_to_build_on_arm:
1
2 ===================================================================
31 How To Build On ARM
42 ===================================================================
195195
196196 Build ``Debug``, ``Release+Asserts``, and ``Release`` versions
197197 of ``llvm`` on all supported platforms. Directions to build ``llvm``
198 are :ref:`here tarted>`.
198 are :doc:`here tarted>`.
199199
200200 Build Clang Binary Distribution
201201 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
None .. _how-to-set-up-llvm-style-rtti:
1
2 ======================================================
31 How to set up LLVM-style RTTI for your class hierarchy
42 ======================================================
None .. _how-to-submit-a-bug-report:
1
2 ================================
31 How to submit an LLVM bug report
42 ================================
None .. _how_to_use_instruction_mappings:
1
2 ===============================
31 How To Use Instruction Mappings
42 ===============================
None .. _lexicon:
1
2 ================
31 The LLVM Lexicon
42 ================
None .. _lto:
1
2 ======================================================
31 LLVM Link Time Optimization: Design and Implementation
42 ======================================================
None .. _makefile_guide:
1
2 ===================
31 LLVM Makefile Guide
42 ===================
None .. _marked_up_disassembly:
1
2 =======================================
31 LLVM's Optional Rich Disassembly Output
42 =======================================
None .. _packaging:
1
2 ========================
31 Advice on Packaging LLVM
42 ========================
7676 (even better, get the book)
7777 `_.
7878
79 You are also encouraged to take a look at the :ref:`LLVM Coding Standards
80 ` guide which focuses on how to write maintainable code more
79 You are also encouraged to take a look at the :doc:`LLVM Coding Standards
80 ` guide which focuses on how to write maintainable code more
8181 than where to put your curly braces.
8282
8383 .. _resources:
177177
178178 These five templates can be used with any classes, whether they have a v-table
179179 or not. If you want to add support for these templates, see the document
180 :ref:`How to set up LLVM-style RTTI for your class hierarchy
181 `
180 :doc:`How to set up LLVM-style RTTI for your class hierarchy
181 `
182182
183183 .. _string_apis:
184184
None .. _projects:
1
2 ========================
31 Creating an LLVM Project
42 ========================
None .. _segmented_stacks:
1
2 ========================
31 Segmented Stacks in LLVM
42 ========================
None .. _tablegen:
1
2 =====================
31 TableGen Fundamentals
42 =====================
None .. _yamlio:
1
2 =====================
31 YAML I/O
42 =====================
None .. _design_and_overview:
1
2 LLVM Design & Overview
31 ======================
42
3028
3129 More details (quite old now).
3230
33 * :ref:`gep`
31 * :doc:`GetElementPtr`
3432
3533 Answers to some very frequent questions about LLVM's most frequently
3634 misunderstood instruction.
None .. _development_process:
1
2 Development Process Documentation
31 =================================
42
108 LLVMBuild
119 HowToReleaseLLVM
1210
13 * :ref:`projects`
11 * :doc:`Projects`
1412
1513 How-to guide and templates for new projects that *use* the LLVM
1614 infrastructure. The templates (directory organization, Makefiles, and test
2220 Describes the LLVMBuild organization and files used by LLVM to specify
2321 component descriptions.
2422
25 * :ref:`makefile_guide`
23 * :doc:`MakefileGuide`
2624
2725 Describes how the LLVM makefiles work and how to use them.
2826
None .. _contents:
1
2 Overview
31 ========
42
1715 * **Design & Overview**
1816
1917 Several introductory papers and presentations are available at
20 :ref:`design_and_overview`.
18 :doc:`design_and_overview`.
2119
2220 * **Publications**
2321
2523
2624 * **User Guides**
2725
28 Those new to the LLVM system should first visit the :ref:`userguides`.
26 Those new to the LLVM system should first visit the :doc:`userguides`.
2927
3028 NOTE: If you are a user who is only interested in using LLVM-based
3129 compilers, you should look into `Clang `_ or
3634 * **API Clients**
3735
3836 Developers of applications which use LLVM as a library should visit the
39 :ref:`programming`.
37 :doc:`programming`.
4038
4139 * **Subsystems**
4240
4341 API clients and LLVM developers may be interested in the
44 :ref:`subsystems` documentation.
42 :doc:`subsystems` documentation.
4543
4644 * **Development Process**
4745
4846 Additional documentation on the LLVM project can be found at
49 :ref:`development_process`.
47 :doc:`development_process`.
5048
5149 * **Mailing Lists**
5250
53 For more information, consider consulting the LLVM :ref:`mailing_lists`.
51 For more information, consider consulting the LLVM :doc:`mailing_lists`.
5452
5553 .. toctree::
5654 :maxdepth: 2
None .. _mailing_lists:
1
2 Mailing Lists
31 =============
42
None .. _programming:
1
2 Programming Documentation
31 =========================
42
1311 HowToSetUpLLVMStyleRTTI
1412 ProgrammersManual
1513
16 * `LLVM Language Reference Manual `_
14 * :doc:`LLVM Language Reference Manual `
1715
1816 Defines the LLVM intermediate representation and the assembly form of the
1917 different nodes.
2018
21 * :ref:`atomics`
19 * :doc:`Atomics`
2220
2321 Information about LLVM's concurrency model.
2422
2725 Introduction to the general layout of the LLVM sourcebase, important classes
2826 and APIs, and some tips & tricks.
2927
30 * :ref:`commandline`
28 * :doc:`CommandLine`
3129
3230 Provides information on using the command line parsing library.
3331
34 * :ref:`coding_standards`
32 * :doc:`CodingStandards`
3533
3634 Details the LLVM coding standards and provides useful information on writing
3735 efficient C++ code.
4139 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
4240 class hierarchy.
4341
44 * :ref:`extending_llvm`
42 * :doc:`ExtendingLLVM`
4543
4644 Look here to see how to add instructions and intrinsics to LLVM.
4745
5250
5351 * `ViewVC Repository Browser `_
5452
55 * :ref:`compiler_writer_info`
53 * :doc:`CompilerWriterInfo`
5654
5755 A list of helpful links for compiler writers.
None .. _subsystems:
1
2 Subsystem Documentation
31 =======================
42
3331
3432 Information on how to write LLVM backends for machine targets.
3533
36 * :ref:`code_generator`
34 * :doc:`CodeGenerator`
3735
3836 The design and implementation of the LLVM code generator. Useful if you are
3937 working on retargetting LLVM to a new architecture, designing a new codegen
4038 pass, or enhancing existing components.
4139
42 * :ref:`tablegen`
40 * :doc:`TableGenFundamentals`
4341
4442 Describes the TableGen tool, which is used heavily by the LLVM code
4543 generator.
4644
47 * :ref:`alias_analysis`
45 * :doc:`AliasAnalysis`
4846
4947 Information on how to write a new alias analysis implementation or how to
5048 use existing analyses.
6361
6462 This document describes the current status of vectorization in LLVM.
6563
66 * :ref:`exception_handling`
64 * :doc:`ExceptionHandling`
6765
6866 This document describes the design and implementation of exception handling
6967 in LLVM.
7068
71 * :ref:`bugpoint`
69 * :doc:`Bugpoint`
7270
7371 Automatic bug finder and test-case reducer description and usage
7472 information.
7573
76 * :ref:`bitcode_format`
74 * :doc:`BitCodeFormat`
7775
7876 This describes the file format and encoding used for LLVM "bc" files.
7977
8280 This document describes the LLVM System Library (``lib/System``) and
8381 how to keep LLVM source code portable
8482
85 * :ref:`lto`
83 * :doc:`LinkTimeOptimization`
8684
8785 This document describes the interface between LLVM intermodular optimizer
8886 and the linker and its design
8987
90 * :ref:`gold-plugin`
88 * :doc:`GoldPlugin`
9189
9290 How to build your programs with link-time optimization on Linux.
9391
94 * :ref:`debugging-jited-code`
92 * :doc:`DebuggingJITedCode`
9593
9694 How to debug JITed code with GDB.
9795
98 * :ref:`branch_weight`
96 * :doc:`BranchWeightMetadata`
9997
10098 Provides information about Branch Prediction Information.
10199
102 * :ref:`segmented_stacks`
100 * :doc:`SegmentedStacks`
103101
104102 This document describes segmented stacks and how they are used in LLVM.
105103
106 * :ref:`marked_up_disassembly`
104 * :doc:`MarkedUpDisassembly`
107105
108106 This document describes the optional rich disassembly output syntax.
109107
None .. _userguides:
1
2 User Guides
31 ===========
42
2523 Passes
2624 YamlIO
2725
28 * :ref:`getting_started`
26 * :doc:`GettingStarted`
2927
3028 Discusses how to get up and running quickly with the LLVM infrastructure.
3129 Everything from unpacking and compilation of the distribution to execution
3230 of some tools.
3331
34 * :ref:`building-with-cmake`
32 * :doc:`CMake`
3533
3634 An addendum to the main Getting Started guide for those using the `CMake
3735 build system `_.
3836
39 * :ref:`how_to_build_on_arm`
37 * :doc:`HowToBuildOnARM`
4038
4139 Notes on building and testing LLVM/Clang on ARM.
4240
5048 Tutorials about using LLVM. Includes a tutorial about making a custom
5149 language with LLVM.
5250
53 * :ref:`developer_policy`
51 * :doc:`DeveloperPolicy`
5452
5553 The LLVM project's policy towards developers and their contributions.
5654
57 * :ref:`LLVM Command Guide >`
55 * :doc:`LLVM Command Guide >`
5856
5957 A reference manual for the LLVM command line utilities ("man" pages for LLVM
6058 tools).
6361
6462 A list of optimizations and analyses implemented in LLVM.
6563
66 * :ref:`faq`
64 * :doc:`FAQ`
6765
6866 A list of common questions and problems and their solutions.
6967
7169
7270 This describes new features, known bugs, and other limitations.
7371
74 * :ref:`how-to-submit-a-bug-report`
72 * :doc:`HowToSubmitABug`
7573
7674 Instructions for properly submitting information about any bugs you run into
7775 in the LLVM system.
8886
8987 Instructions for building the clang front-end from source.
9088
91 * :ref:`packaging`
89 * :doc:`Packaging`
9290
9391 Advice on packaging LLVM into a distribution.
9492
95 * :ref:`lexicon`
93 * :doc:`Lexicon`
9694
9795 Definition of acronyms, terms and concepts used in LLVM.
9896
99 * :ref:`how_to_add_a_builder`
97 * :doc:`HowToAddABuilder`
10098
10199 Instructions for adding new builder to LLVM buildbot master.
102100
103 * :ref:`yamlio`
101 * :doc:`YamlIO`
104102
105103 A reference guide for using LLVM's YAML I/O library.
106104
None .. _yaml2obj:
1
2 yaml2obj
31 ========
42