diff options
author | Daniel Dunbar <daniel@zuster.org> | 2012-04-19 16:31:37 +0000 |
---|---|---|
committer | Daniel Dunbar <daniel@zuster.org> | 2012-04-19 16:31:37 +0000 |
commit | 21e993c1b1083ef91441a363997d0efc8e646191 (patch) | |
tree | 1c07b2ea2dd18b8219d46415cee365abc93578e2 /docs/userguides.rst | |
parent | 75083ebc09a3dd47099e3912ac090dbc907f3eaf (diff) | |
download | llvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.gz llvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.bz2 llvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.xz |
[docs] Convert docs index page into Sphinx.
- Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation.
- Lots of styling, editing, and integration work yet to comeā¦
- PR12589
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155133 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/userguides.rst')
-rw-r--r-- | docs/userguides.rst | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/userguides.rst b/docs/userguides.rst new file mode 100644 index 0000000000..96102dd25e --- /dev/null +++ b/docs/userguides.rst @@ -0,0 +1,78 @@ +.. _userguides: + +User Guides +=========== + + * `The LLVM Getting Started Guide <GettingStarted.html>`_ + + 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. + + * `LLVM CMake guide <CMake.html>`_ + + An addendum to the main Getting Started guide for those using the `CMake + build system <http://www.cmake.org>`_. + + * `Getting Started with the LLVM System using Microsoft Visual Studio + <GettingStartedVS.html>`_ + + An addendum to the main Getting Started guide for those using Visual Studio + on Windows. + + * `LLVM Tutorial <tutorial/>`_ + + A walk through the process of using LLVM for a custom language, and the + facilities LLVM offers in tutorial form. + + * `Developer Policy <DeveloperPolicy.html>`_ + + The LLVM project's policy towards developers and their contributions. + + * `LLVM Command Guide <CommandGuide/index.html>`_ + + A reference manual for the LLVM command line utilities ("man" pages for LLVM + tools). + + * `LLVM's Analysis and Transform Passes <Passes.html>`_ + + A list of optimizations and analyses implemented in LLVM. + + * `Frequently Asked Questions <FAQ.html>`_ + + A list of common questions and problems and their solutions. + + * `Release notes for the current release <ReleaseNotes.html>`_ + + This describes new features, known bugs, and other limitations. + + * `How to Submit A Bug Report <HowToSubmitABug.html>`_ + + Instructions for properly submitting information about any bugs you run into + in the LLVM system. + + * `LLVM Testing Infrastructure Guide <TestingGuide.html>`_ + + A reference manual for using the LLVM testing infrastructure. + + * `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_ + + Instructions for building the clang front-end from source. + + * `Packaging guide <Packaging.html>`_ + + Advice on packaging LLVM into a distribution. + + * `The LLVM Lexicon <Lexicon.html>`_ + + Definition of acronyms, terms and concepts used in LLVM. + + * `How To Add Your Build Configuration To LLVM Buildbot Infrastructure <HowToAddABuilder.html>`_ + + Instructions for adding new builder to LLVM buildbot master. + + * **IRC** -- You can probably find help on the unofficial LLVM IRC. + + We often are on irc.oftc.net in the #llvm channel. If you are using the + mozilla browser, and have chatzilla installed, you can `join #llvm on + irc.oftc.net <irc://irc.oftc.net/llvm>`_. |