Daniel Dunbar | fbb8041 | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 1 | Overview |
| 2 | ======== |
| 3 | |
| 4 | .. warning:: |
| 5 | |
| 6 | If you are using a released version of LLVM, see `the download page |
| 7 | <http://llvm.org/releases/>`_ to find your documentation. |
| 8 | |
| 9 | The LLVM compiler infrastructure supports a wide range of projects, from |
| 10 | industrial strength compilers to specialized JIT applications to small |
| 11 | research projects. |
| 12 | |
| 13 | Similarly, documentation is broken down into several high-level groupings |
Benjamin Kramer | bde9176 | 2012-06-02 10:20:22 +0000 | [diff] [blame] | 14 | targeted at different audiences: |
Daniel Dunbar | fbb8041 | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 15 | |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 16 | LLVM Design & Overview |
| 17 | ====================== |
Daniel Dunbar | fbb8041 | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 18 | |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 19 | Several introductory papers and presentations. |
Daniel Dunbar | fbb8041 | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 20 | |
| 21 | .. toctree:: |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 22 | :hidden: |
Daniel Dunbar | fbb8041 | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 23 | |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 24 | LangRef |
| 25 | GetElementPtr |
| 26 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 27 | :doc:`LangRef` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 28 | Defines the LLVM intermediate representation. |
| 29 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 30 | `Introduction to the LLVM Compiler`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 31 | Presentation providing a users introduction to LLVM. |
| 32 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 33 | .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 34 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 35 | `Intro to LLVM`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 36 | Book chapter providing a compiler hacker's introduction to LLVM. |
| 37 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 38 | .. __: http://www.aosabook.org/en/llvm.html |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 39 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 40 | |
| 41 | `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 42 | Design overview. |
| 43 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 44 | .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 45 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 46 | `LLVM: An Infrastructure for Multi-Stage Optimization`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 47 | More details (quite old now). |
| 48 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 49 | .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 50 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 51 | :doc:`GetElementPtr` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 52 | Answers to some very frequent questions about LLVM's most frequently |
| 53 | misunderstood instruction. |
| 54 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 55 | `Publications mentioning LLVM <http://llvm.org/pubs>`_ |
| 56 | .. |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 57 | |
| 58 | User Guides |
| 59 | =========== |
| 60 | |
| 61 | For those new to the LLVM system. |
| 62 | |
| 63 | NOTE: If you are a user who is only interested in using LLVM-based |
| 64 | compilers, you should look into `Clang <http://clang.llvm.org>`_ or |
| 65 | `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is |
| 66 | intended for users who have a need to work with the intermediate LLVM |
| 67 | representation. |
| 68 | |
| 69 | .. toctree:: |
| 70 | :hidden: |
| 71 | |
| 72 | CMake |
| 73 | HowToBuildOnARM |
| 74 | CommandGuide/index |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 75 | GettingStarted |
| 76 | GettingStartedVS |
| 77 | FAQ |
| 78 | Lexicon |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 79 | HowToAddABuilder |
| 80 | yaml2obj |
| 81 | HowToSubmitABug |
| 82 | SphinxQuickstartTemplate |
| 83 | Phabricator |
| 84 | TestingGuide |
| 85 | tutorial/index |
| 86 | ReleaseNotes |
| 87 | Passes |
| 88 | YamlIO |
| 89 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 90 | :doc:`GettingStarted` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 91 | Discusses how to get up and running quickly with the LLVM infrastructure. |
| 92 | Everything from unpacking and compilation of the distribution to execution |
| 93 | of some tools. |
| 94 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 95 | :doc:`CMake` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 96 | An addendum to the main Getting Started guide for those using the `CMake |
| 97 | build system <http://www.cmake.org>`_. |
| 98 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 99 | :doc:`HowToBuildOnARM` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 100 | Notes on building and testing LLVM/Clang on ARM. |
| 101 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 102 | :doc:`GettingStartedVS` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 103 | An addendum to the main Getting Started guide for those using Visual Studio |
| 104 | on Windows. |
| 105 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 106 | :doc:`tutorial/index` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 107 | Tutorials about using LLVM. Includes a tutorial about making a custom |
| 108 | language with LLVM. |
| 109 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 110 | :doc:`LLVM Command Guide <CommandGuide/index>` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 111 | A reference manual for the LLVM command line utilities ("man" pages for LLVM |
| 112 | tools). |
| 113 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 114 | :doc:`Passes` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 115 | A list of optimizations and analyses implemented in LLVM. |
| 116 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 117 | :doc:`FAQ` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 118 | A list of common questions and problems and their solutions. |
| 119 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 120 | :doc:`Release notes for the current release <ReleaseNotes>` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 121 | This describes new features, known bugs, and other limitations. |
| 122 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 123 | :doc:`HowToSubmitABug` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 124 | Instructions for properly submitting information about any bugs you run into |
| 125 | in the LLVM system. |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 126 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 127 | :doc:`SphinxQuickstartTemplate` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 128 | A template + tutorial for writing new Sphinx documentation. It is meant |
| 129 | to be read in source form. |
| 130 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 131 | :doc:`LLVM Testing Infrastructure Guide <TestingGuide>` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 132 | A reference manual for using the LLVM testing infrastructure. |
| 133 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 134 | `How to build the C, C++, ObjC, and ObjC++ front end`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 135 | Instructions for building the clang front-end from source. |
| 136 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 137 | .. __: http://clang.llvm.org/get_started.html |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 138 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 139 | :doc:`Lexicon` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 140 | Definition of acronyms, terms and concepts used in LLVM. |
| 141 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 142 | :doc:`HowToAddABuilder` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 143 | Instructions for adding new builder to LLVM buildbot master. |
| 144 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 145 | :doc:`YamlIO` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 146 | A reference guide for using LLVM's YAML I/O library. |
| 147 | |
| 148 | IRC |
| 149 | === |
| 150 | |
Michael J. Spencer | 0ad0f5e | 2013-01-20 09:38:14 +0000 | [diff] [blame] | 151 | Users and developers of the LLVM project (including subprojects such as Clang) |
| 152 | can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_. |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 153 | |
Michael J. Spencer | 0ad0f5e | 2013-01-20 09:38:14 +0000 | [diff] [blame] | 154 | This channel has several bots. |
| 155 | |
| 156 | * Buildbot reporters |
| 157 | |
| 158 | * llvmbb - Bot for the main LLVM buildbot master. |
| 159 | http://lab.llvm.org:8011/console |
| 160 | * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console |
| 161 | * smooshlab - Apple's internal buildbot master. |
| 162 | |
| 163 | * robot - Bugzilla linker. %bug <number> |
| 164 | |
| 165 | * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running |
| 166 | near-trunk clang instead of gcc. |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 167 | |
| 168 | Programming Documentation |
| 169 | ========================= |
| 170 | |
| 171 | For developers of applications which use LLVM as a library. |
| 172 | |
| 173 | .. toctree:: |
| 174 | :hidden: |
| 175 | |
| 176 | Atomics |
| 177 | CodingStandards |
| 178 | CommandLine |
| 179 | CompilerWriterInfo |
| 180 | ExtendingLLVM |
| 181 | HowToSetUpLLVMStyleRTTI |
| 182 | ProgrammersManual |
| 183 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 184 | :doc:`LLVM Language Reference Manual <LangRef>` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 185 | Defines the LLVM intermediate representation and the assembly form of the |
| 186 | different nodes. |
| 187 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 188 | :doc:`Atomics` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 189 | Information about LLVM's concurrency model. |
| 190 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 191 | :doc:`ProgrammersManual` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 192 | Introduction to the general layout of the LLVM sourcebase, important classes |
| 193 | and APIs, and some tips & tricks. |
| 194 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 195 | :doc:`CommandLine` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 196 | Provides information on using the command line parsing library. |
| 197 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 198 | :doc:`CodingStandards` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 199 | Details the LLVM coding standards and provides useful information on writing |
| 200 | efficient C++ code. |
| 201 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 202 | :doc:`HowToSetUpLLVMStyleRTTI` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 203 | How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your |
| 204 | class hierarchy. |
| 205 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 206 | :doc:`ExtendingLLVM` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 207 | Look here to see how to add instructions and intrinsics to LLVM. |
| 208 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 209 | `Doxygen generated documentation <http://llvm.org/doxygen/>`_ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 210 | (`classes <http://llvm.org/doxygen/inherits.html>`_) |
| 211 | (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_) |
| 212 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 213 | `ViewVC Repository Browser <http://llvm.org/viewvc/>`_ |
| 214 | .. |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 215 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 216 | :doc:`CompilerWriterInfo` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 217 | A list of helpful links for compiler writers. |
| 218 | |
| 219 | Subsystem Documentation |
| 220 | ======================= |
| 221 | |
| 222 | For API clients and LLVM developers. |
| 223 | |
| 224 | .. toctree:: |
| 225 | :hidden: |
| 226 | |
| 227 | AliasAnalysis |
| 228 | BitCodeFormat |
| 229 | BranchWeightMetadata |
| 230 | Bugpoint |
| 231 | CodeGenerator |
| 232 | ExceptionHandling |
| 233 | LinkTimeOptimization |
| 234 | SegmentedStacks |
| 235 | TableGenFundamentals |
| 236 | DebuggingJITedCode |
| 237 | GoldPlugin |
| 238 | MarkedUpDisassembly |
| 239 | SystemLibrary |
| 240 | SourceLevelDebugging |
| 241 | Vectorizers |
| 242 | WritingAnLLVMBackend |
| 243 | GarbageCollection |
| 244 | WritingAnLLVMPass |
| 245 | TableGen/LangRef |
Joe Abbey | ba3e901 | 2013-02-12 11:45:22 +0000 | [diff] [blame] | 246 | HowToUseAttributes |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 247 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 248 | :doc:`WritingAnLLVMPass` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 249 | Information on how to write LLVM transformations and analyses. |
| 250 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 251 | :doc:`WritingAnLLVMBackend` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 252 | Information on how to write LLVM backends for machine targets. |
| 253 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 254 | :doc:`CodeGenerator` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 255 | The design and implementation of the LLVM code generator. Useful if you are |
| 256 | working on retargetting LLVM to a new architecture, designing a new codegen |
| 257 | pass, or enhancing existing components. |
| 258 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 259 | :doc:`TableGenFundamentals` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 260 | Describes the TableGen tool, which is used heavily by the LLVM code |
| 261 | generator. |
| 262 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 263 | :doc:`AliasAnalysis` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 264 | Information on how to write a new alias analysis implementation or how to |
| 265 | use existing analyses. |
| 266 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 267 | :doc:`GarbageCollection` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 268 | The interfaces source-language compilers should use for compiling GC'd |
| 269 | programs. |
| 270 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 271 | :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 272 | This document describes the design and philosophy behind the LLVM |
| 273 | source-level debugger. |
| 274 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 275 | :doc:`Vectorizers` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 276 | This document describes the current status of vectorization in LLVM. |
| 277 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 278 | :doc:`ExceptionHandling` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 279 | This document describes the design and implementation of exception handling |
| 280 | in LLVM. |
| 281 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 282 | :doc:`Bugpoint` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 283 | Automatic bug finder and test-case reducer description and usage |
| 284 | information. |
| 285 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 286 | :doc:`BitCodeFormat` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 287 | This describes the file format and encoding used for LLVM "bc" files. |
| 288 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 289 | :doc:`System Library <SystemLibrary>` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 290 | This document describes the LLVM System Library (``lib/System``) and |
| 291 | how to keep LLVM source code portable |
| 292 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 293 | :doc:`LinkTimeOptimization` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 294 | This document describes the interface between LLVM intermodular optimizer |
| 295 | and the linker and its design |
| 296 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 297 | :doc:`GoldPlugin` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 298 | How to build your programs with link-time optimization on Linux. |
| 299 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 300 | :doc:`DebuggingJITedCode` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 301 | How to debug JITed code with GDB. |
| 302 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 303 | :doc:`BranchWeightMetadata` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 304 | Provides information about Branch Prediction Information. |
| 305 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 306 | :doc:`SegmentedStacks` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 307 | This document describes segmented stacks and how they are used in LLVM. |
| 308 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 309 | :doc:`MarkedUpDisassembly` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 310 | This document describes the optional rich disassembly output syntax. |
| 311 | |
Joe Abbey | ba3e901 | 2013-02-12 11:45:22 +0000 | [diff] [blame] | 312 | :doc:`HowToUseAttributes` |
| 313 | Answers some questions about the new Attributes infrastructure. |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 314 | |
| 315 | Development Process Documentation |
| 316 | ================================= |
| 317 | |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 318 | Information about LLVM's development process. |
| 319 | |
| 320 | .. toctree:: |
| 321 | :hidden: |
| 322 | |
Sean Silva | 9d205c8 | 2013-03-30 15:32:47 +0000 | [diff] [blame^] | 323 | DeveloperPolicy |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 324 | MakefileGuide |
| 325 | Projects |
| 326 | LLVMBuild |
| 327 | HowToReleaseLLVM |
Sean Silva | bdb940f | 2013-01-28 21:28:10 +0000 | [diff] [blame] | 328 | Packaging |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 329 | |
Sean Silva | 9d205c8 | 2013-03-30 15:32:47 +0000 | [diff] [blame^] | 330 | :doc:`DeveloperPolicy` |
| 331 | The LLVM project's policy towards developers and their contributions. |
| 332 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 333 | :doc:`Projects` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 334 | How-to guide and templates for new projects that *use* the LLVM |
| 335 | infrastructure. The templates (directory organization, Makefiles, and test |
| 336 | tree) allow the project code to be located outside (or inside) the ``llvm/`` |
| 337 | tree, while using LLVM header files and libraries. |
| 338 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 339 | :doc:`LLVMBuild` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 340 | Describes the LLVMBuild organization and files used by LLVM to specify |
| 341 | component descriptions. |
| 342 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 343 | :doc:`MakefileGuide` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 344 | Describes how the LLVM makefiles work and how to use them. |
| 345 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 346 | :doc:`HowToReleaseLLVM` |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 347 | This is a guide to preparing LLVM releases. Most developers can ignore it. |
| 348 | |
Sean Silva | bdb940f | 2013-01-28 21:28:10 +0000 | [diff] [blame] | 349 | :doc:`Packaging` |
| 350 | Advice on packaging LLVM into a distribution. |
| 351 | |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 352 | Mailing Lists |
| 353 | ============= |
| 354 | |
| 355 | If you can't find what you need in these docs, try consulting the mailing |
| 356 | lists. |
| 357 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 358 | `LLVM Announcements List`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 359 | This is a low volume list that provides important announcements regarding |
| 360 | LLVM. It gets email about once a month. |
| 361 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 362 | .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 363 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 364 | `Developer's List`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 365 | This list is for people who want to be included in technical discussions of |
| 366 | LLVM. People post to this list when they have questions about writing code |
| 367 | for or using the LLVM tools. It is relatively low volume. |
| 368 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 369 | .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 370 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 371 | `Bugs & Patches Archive`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 372 | This list gets emailed every time a bug is opened and closed, and when people |
| 373 | submit patches to be included in LLVM. It is higher volume than the LLVMdev |
| 374 | list. |
| 375 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 376 | .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 377 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 378 | `Commits Archive`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 379 | This list contains all commit messages that are made when LLVM developers |
| 380 | commit code changes to the repository. It is useful for those who want to |
| 381 | stay on the bleeding edge of LLVM development. This list is very high volume. |
| 382 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 383 | .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 384 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 385 | `Test Results Archive`__ |
Sean Silva | 12159ff | 2013-01-20 02:19:36 +0000 | [diff] [blame] | 386 | A message is automatically sent to this list by every active nightly tester |
| 387 | when it completes. As such, this list gets email several times each day, |
| 388 | making it a high volume list. |
| 389 | |
Sean Silva | 9d0eb94 | 2013-01-20 02:19:42 +0000 | [diff] [blame] | 390 | .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/ |
| 391 | |
Daniel Dunbar | fbb8041 | 2012-04-19 16:31:37 +0000 | [diff] [blame] | 392 | Indices and tables |
| 393 | ================== |
| 394 | |
| 395 | * :ref:`genindex` |
| 396 | * :ref:`search` |