diff options
44 files changed, 43 insertions, 127 deletions
diff --git a/docs/AliasAnalysis.rst b/docs/AliasAnalysis.rst index 54b4a4a746..712d57d14b 100644 --- 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 index 1bca53e2b1..705d73fbab 100644 --- 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 index 333e79b864..c83b6c1801 100644 --- 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 index 2667ce3589..71ecd34c82 100644 --- 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 index 047129f410..1a5fc8c027 100644 --- 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 index f89578863c..6eab04b970 100644 --- 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 index ce23667eb3..78f7287bef 100644 --- 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 index 8003c12497..6377763d8d 100644 --- 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 index 73a4835dd7..9bfa9645d8 100644 --- 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 index fe5819abeb..073958b16b 100644 --- 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 index f21491994f..0744656f03 100644 --- 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 index 53b2e89e5e..d6101d5100 100644 --- 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 index 925e769b86..43bdc85985 100644 --- 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 index 190f18261d..47fecd38e4 100644 --- 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 index 6df08eee98..3d8e9ee79a 100644 --- 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 index b4c6261c65..e4ab2c18f7 100644 --- 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 index 3b57d78cf1..306a2a87ef 100644 --- 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 index 322c3558a5..8503396a3b 100644 --- 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 index 35f97f04b9..4c80f2c57b 100644 --- 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 index 722a9a1bb0..17bbeb8ba9 100644 --- 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 index f472f74e37..893f12d19d 100644 --- 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 index 4e25639593..13de7d1b44 100644 --- 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 index 7bd5e14ff8..208b9b7632 100644 --- 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 index a2e46b3d7f..b906b25621 100644 --- 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 index 2f852ed987..45be2826b3 100644 --- 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 index d566eba326..8a3e7c8d72 100644 --- 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 index cbe1585226..10821f4712 100644 --- 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 index 822196ccf4..c15abd325e 100644 --- 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 index 4988fe664d..6e8cce9c53 100644 --- 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 index e1282e102e..cc4dbc817e 100644 --- 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 index 6e74158d72..7c2dc95612 100644 --- 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 index 5e443c84a4..fefe497eb3 100644 --- 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 index c5d03d33a0..3a5744aedb 100644 --- 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 index f97d62abda..e44ce42313 100644 --- 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 index 73bcd66a60..526795f53d 100644 --- 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 index b009b67ef4..f87f61f44a 100644 --- 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 index 4b1d627380..2fc377f3aa 100644 --- 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 index ecd4c6a616..86d611cab9 100644 --- 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 index d406b52574..6aefc86b10 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/mailing_lists.rst b/docs/mailing_lists.rst index 106f1da48f..d6ac9c730b 100644 --- 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 index 3fea6ed427..aa51130533 100644 --- 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. diff --git a/docs/subsystems.rst b/docs/subsystems.rst index 505c573075..7430c82f1c 100644 --- a/docs/subsystems.rst +++ b/docs/subsystems.rst @@ -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. diff --git a/docs/userguides.rst b/docs/userguides.rst index c0a4356b0e..e7e4518afc 100644 --- a/docs/userguides.rst +++ b/docs/userguides.rst @@ -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. diff --git a/docs/yaml2obj.rst b/docs/yaml2obj.rst index d051e7e22c..b269806e06 100644 --- a/docs/yaml2obj.rst +++ b/docs/yaml2obj.rst @@ -1,5 +1,3 @@ -.. _yaml2obj: - yaml2obj ======== |