| Micah Villmow | 593c0b0 | 2012-09-27 17:51:02 +0000 | [diff] [blame] | 1 | .. _userguides: |
| 2 | |
| 3 | User Guides |
| 4 | =========== |
| 5 | |
| 6 | .. toctree:: |
| 7 | :hidden: |
| 8 | |
| 9 | CMake |
| 10 | HowToBuildOnARM |
| 11 | CommandGuide/index |
| 12 | DeveloperPolicy |
| Bill Wendling | f93c55a | 2012-10-07 07:10:13 +0000 | [diff] [blame] | 13 | GettingStarted |
| Micah Villmow | 593c0b0 | 2012-09-27 17:51:02 +0000 | [diff] [blame] | 14 | GettingStartedVS |
| 15 | FAQ |
| 16 | Lexicon |
| 17 | Packaging |
| 18 | HowToAddABuilder |
| 19 | yaml2obj |
| Sean Silva | 87ed553 | 2012-09-25 20:52:04 +0000 | [diff] [blame] | 20 | HowToSubmitABug |
| Micah Villmow | 593c0b0 | 2012-09-27 17:51:02 +0000 | [diff] [blame] | 21 | |
| Bill Wendling | f93c55a | 2012-10-07 07:10:13 +0000 | [diff] [blame] | 22 | * :ref:`getting_started` |
| Micah Villmow | 593c0b0 | 2012-09-27 17:51:02 +0000 | [diff] [blame] | 23 | |
| 24 | Discusses how to get up and running quickly with the LLVM infrastructure. |
| 25 | Everything from unpacking and compilation of the distribution to execution |
| 26 | of some tools. |
| 27 | |
| 28 | * :ref:`building-with-cmake` |
| 29 | |
| 30 | An addendum to the main Getting Started guide for those using the `CMake |
| 31 | build system <http://www.cmake.org>`_. |
| 32 | |
| 33 | * :ref:`how_to_build_on_arm` |
| 34 | |
| 35 | Notes on building and testing LLVM/Clang on ARM. |
| 36 | |
| 37 | * `Getting Started with the LLVM System using Microsoft Visual Studio |
| 38 | <GettingStartedVS.html>`_ |
| 39 | |
| 40 | An addendum to the main Getting Started guide for those using Visual Studio |
| 41 | on Windows. |
| 42 | |
| 43 | * `LLVM Tutorial <tutorial/>`_ |
| 44 | |
| 45 | A walk through the process of using LLVM for a custom language, and the |
| 46 | facilities LLVM offers in tutorial form. |
| 47 | |
| 48 | * :ref:`developer_policy` |
| 49 | |
| 50 | The LLVM project's policy towards developers and their contributions. |
| 51 | |
| 52 | * :ref:`LLVM Command Guide <commands>` |
| 53 | |
| 54 | A reference manual for the LLVM command line utilities ("man" pages for LLVM |
| 55 | tools). |
| 56 | |
| 57 | * `LLVM's Analysis and Transform Passes <Passes.html>`_ |
| 58 | |
| 59 | A list of optimizations and analyses implemented in LLVM. |
| 60 | |
| 61 | * :ref:`faq` |
| 62 | |
| 63 | A list of common questions and problems and their solutions. |
| 64 | |
| 65 | * `Release notes for the current release <ReleaseNotes.html>`_ |
| 66 | |
| 67 | This describes new features, known bugs, and other limitations. |
| 68 | |
| Sean Silva | 87ed553 | 2012-09-25 20:52:04 +0000 | [diff] [blame] | 69 | * :ref:`how-to-submit-a-bug-report` |
| Micah Villmow | 593c0b0 | 2012-09-27 17:51:02 +0000 | [diff] [blame] | 70 | |
| 71 | Instructions for properly submitting information about any bugs you run into |
| 72 | in the LLVM system. |
| 73 | |
| 74 | * `LLVM Testing Infrastructure Guide <TestingGuide.html>`_ |
| 75 | |
| 76 | A reference manual for using the LLVM testing infrastructure. |
| 77 | |
| 78 | * `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_ |
| 79 | |
| 80 | Instructions for building the clang front-end from source. |
| 81 | |
| 82 | * :ref:`packaging` |
| 83 | |
| 84 | Advice on packaging LLVM into a distribution. |
| 85 | |
| 86 | * :ref:`lexicon` |
| 87 | |
| 88 | Definition of acronyms, terms and concepts used in LLVM. |
| 89 | |
| 90 | * :ref:`how_to_add_a_builder` |
| 91 | |
| 92 | Instructions for adding new builder to LLVM buildbot master. |
| 93 | |
| 94 | * **IRC** -- You can probably find help on the unofficial LLVM IRC. |
| 95 | |
| 96 | We often are on irc.oftc.net in the #llvm channel. If you are using the |
| 97 | mozilla browser, and have chatzilla installed, you can `join #llvm on |
| 98 | irc.oftc.net <irc://irc.oftc.net/llvm>`_. |