| DeForest Richards | ccf6030 | 2019-09-25 00:49:02 +0000 | [diff] [blame] | 1 | Reference
|
| 2 | =========
|
| 3 |
|
| 4 | LLVM and API reference documentation.
|
| 5 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 6 | .. contents::
|
| 7 | :local:
|
| 8 |
|
| DeForest Richards | ccf6030 | 2019-09-25 00:49:02 +0000 | [diff] [blame] | 9 | .. toctree::
|
| 10 | :hidden:
|
| 11 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 12 | Bugpoint
|
| 13 | CommandGuide/index
|
| DeForest Richards | ccf6030 | 2019-09-25 00:49:02 +0000 | [diff] [blame] | 14 | CompilerWriterInfo
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 15 | FuzzingLLVM
|
| 16 | GarbageCollection
|
| 17 | GetElementPtr
|
| 18 | LangRef
|
| 19 | LibFuzzer
|
| DeForest Richards | ccf6030 | 2019-09-25 00:49:02 +0000 | [diff] [blame] | 20 | MIRLangRef
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 21 | PDB/index
|
| 22 | Statepoints
|
| 23 | TestingGuide
|
| 24 | YamlIO
|
| DeForest Richards | eb78dea | 2019-09-29 15:31:52 +0000 | [diff] [blame] | 25 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 26 | API Reference
|
| 27 | -------------
|
| 28 |
|
| 29 | `Doxygen generated documentation <http://llvm.org/doxygen/>`_
|
| 30 | (`classes <http://llvm.org/doxygen/inherits.html>`_)
|
| 31 |
|
| 32 | `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
|
| 33 |
|
| DeForest Richards | eb78dea | 2019-09-29 15:31:52 +0000 | [diff] [blame] | 34 | LLVM Reference
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 35 | --------------
|
| DeForest Richards | ccf6030 | 2019-09-25 00:49:02 +0000 | [diff] [blame] | 36 |
|
| 37 | :doc:`LLVM Language Reference Manual <LangRef>`
|
| 38 | Defines the LLVM intermediate representation and the assembly form of the
|
| 39 | different nodes.
|
| 40 |
|
| DeForest Richards | ccf6030 | 2019-09-25 00:49:02 +0000 | [diff] [blame] | 41 | :doc:`CompilerWriterInfo`
|
| 42 | A list of helpful links for compiler writers.
|
| 43 |
|
| 44 | :doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
|
| 45 | A reference manual for the MIR serialization format, which is used to test
|
| 46 | LLVM's code generation passes.
|
| 47 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 48 | :doc:`YamlIO`
|
| 49 | A reference guide for using LLVM's YAML I/O library.
|
| DeForest Richards | eb78dea | 2019-09-29 15:31:52 +0000 | [diff] [blame] | 50 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 51 | :doc:`GetElementPtr`
|
| 52 | Answers to some very frequent questions about LLVM's most frequently
|
| 53 | misunderstood instruction.
|
| DeForest Richards | eb78dea | 2019-09-29 15:31:52 +0000 | [diff] [blame] | 54 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 55 | ======================
|
| 56 | Command Line Utilities
|
| 57 | ======================
|
| DeForest Richards | eb78dea | 2019-09-29 15:31:52 +0000 | [diff] [blame] | 58 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 59 | :doc:`LLVM Command Guide <CommandGuide/index>`
|
| 60 | A reference manual for the LLVM command line utilities ("man" pages for LLVM
|
| 61 | tools).
|
| DeForest Richards | ccf6030 | 2019-09-25 00:49:02 +0000 | [diff] [blame] | 62 |
|
| DeForest Richards | 6d19651 | 2019-10-06 15:36:37 +0000 | [diff] [blame] | 63 | :doc:`Bugpoint`
|
| 64 | Automatic bug finder and test-case reducer description and usage
|
| 65 | information.
|
| 66 |
|
| 67 | :doc:`The Microsoft PDB File Format <PDB/index>`
|
| 68 | A detailed description of the Microsoft PDB (Program Database) file format.
|
| 69 |
|
| 70 | ==================
|
| 71 | Garbage Collection
|
| 72 | ==================
|
| 73 |
|
| 74 | :doc:`GarbageCollection`
|
| 75 | The interfaces source-language compilers should use for compiling GC'd
|
| 76 | programs.
|
| 77 |
|
| 78 | :doc:`Statepoints`
|
| 79 | This describes a set of experimental extensions for garbage
|
| 80 | collection support.
|
| 81 |
|
| 82 | =========
|
| 83 | LibFuzzer
|
| 84 | =========
|
| 85 |
|
| 86 | :doc:`LibFuzzer`
|
| 87 | A library for writing in-process guided fuzzers.
|
| 88 |
|
| 89 | :doc:`FuzzingLLVM`
|
| 90 | Information on writing and using Fuzzers to find bugs in LLVM.
|
| 91 |
|
| 92 | =======
|
| 93 | Testing
|
| 94 | =======
|
| 95 |
|
| 96 | :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
|
| 97 | A reference manual for using the LLVM testing infrastructure.
|
| 98 |
|
| 99 | :doc:`TestSuiteGuide`
|
| 100 | Describes how to compile and run the test-suite benchmarks. |