summaryrefslogtreecommitdiff
path: root/docs/GettingStarted.rst
Commit message (Collapse)AuthorAge
* fixed more typosSanjay Patel2014-05-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@209921 91177308-0d34-0410-b5e6-96231b3b80d8
* added link to CMake pageSanjay Patel2014-05-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@209918 91177308-0d34-0410-b5e6-96231b3b80d8
* fixed typoSanjay Patel2014-05-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@209916 91177308-0d34-0410-b5e6-96231b3b80d8
* Sync list of targets with configure's realityJeroen Ketema2014-05-29
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@209855 91177308-0d34-0410-b5e6-96231b3b80d8
* Remove projects/sample.Rafael Espindola2014-03-12
| | | | | | | | | | | | | | | As an example that was not actually being used, it suffered from a slow bitrot. The two main issues with it were that it had no cmake support and included a copy of the autoconf directory. The reality is that autoconf is not easily composable. The lack of composabilty is why we have clang options in llvm's configure. Suggesting that users include a copy of autoconf/ in their projects seems a bad idea. We are also in the process of switching to cmake, so pushing autoconf to new project is probably not what we want. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@203728 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Fix some Sphinx warnings.Sean Silva2014-03-02
| | | | | | | | | | | | | | | | | | | | | | | The docs now build cleanly. Yay! The following warnings were fixed: /home/sean/pg/llvm/llvm/docs/HowToReleaseLLVM.rst:364: WARNING: Enumerated list ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/InAlloca.rst:: WARNING: document isn't included in any toctree /home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short. Supported C++11 Language and Library Features ------------------------------------------- /home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short. Supported C++11 Language and Library Features ------------------------------------------- /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:185: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:565: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:567: WARNING: Block quote ends without a blank line; unexpected unindent. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202603 91177308-0d34-0410-b5e6-96231b3b80d8
* add missing 3.4 releaseGabor Greif2014-02-28
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202531 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Tweak the example to match what is apparantly the desired formChandler Carruth2014-02-28
| | | | | | for the style templates we're using. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202494 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Switch to external hyperlink references. Much more readable andChandler Carruth2014-02-28
| | | | | | hopefully easier to get the formatting right for ReST. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202493 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Fix my links to use the correct ReST syntax.Chandler Carruth2014-02-28
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202490 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Fix 80-column wrap that I messed up.Chandler Carruth2014-02-28
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202489 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Tweak discussion of BSDs based on feedback from Roman Divacky.Chandler Carruth2014-02-28
| | | | | | | FreeBSD 10.0 and newer have a modern Clang toolchain that should work well. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202488 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Add a big section with details about how to go about acquiringChandler Carruth2014-02-28
| | | | | | | | | | | | a more modern host C++ toolchain for Linux distros where folks sometimes don't have a good option to get one as part of their system. This is a first cut, so feedback, testing, and suggestions are very, very welcom. This is one of the last real documentation changes that was specifically requested prior to switching LLVM and Clang to build in C++11 mode by default. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202486 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Stop advertising 'make update'. It isn't implemented in CMake andChandler Carruth2014-02-27
| | | | | | | | | | | seems unlikely to be added. It also doesn't seem like it should be part of the build system at all (consider out-of-tree builds). We should probably add nice, easy tool for this that works both for svn client trees and git-svn client trees, but it probably won't be spelled "make update". git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202430 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Actually spell out the new version requirements for the host C++Chandler Carruth2014-02-27
| | | | | | | | | | | | | | | | | | | toolchain of LLVM. These are already being enforced by the build system and have been discussed quite a few times on the lists, but documentation is important. =] Also, garbage collect the majority of the information about broken host GCC toolchains. These aren't really relevant any more as they're all older than the minimum requirement. I've left a few notes about compilers one step older than the current requirement as these compilers are at least conceivable to use, and it's better to preserve this kind of hard-won institutional knowledge. The next step will be some specific docs on how to set up a sufficiently modern host toolchain if your system doesn't come with one. But that'll be tomorrow. =] git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202375 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Clean up some of the required software to not mention irrelevantChandler Carruth2014-02-27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | bits of software and to use a modern GCC version. The Subversion bit was weird anyways -- it has nothing to do with compiling LLVM. Also, there are many other ways to get at the trunk source (git, git-svn, etc). The TeXinfo thing... I have no idea about. But you can get a working LLVM w/o it pretty easily. If man pages or something are missing, that hardly seems like a problem. If folks really want this back, let me know, but it seems mostly like a distraction. I'd still like to separate this into: - Required software to compile. - Optional software to compile. - Required software for certain *contributor* activities (like regenerating configure scripts). Also we need to mention that there are multiple options for build systems, and the differences. Also we should mention Windows. Also probably other stuff I'm forgetting. I'm wondering if this whole thing needs to be shot in the head and we should just start a new, simpler getting started that doesn't have so many years of accumulated stuff that is no longer relevant. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202373 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Switch this table to the simple form as well. No content changed.Chandler Carruth2014-02-27
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202372 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Switch to the incredibly simpler "simple table" form. It nowChandler Carruth2014-02-27
| | | | | | | actually looks like the table on the webpage and is entertainingly smaller, easier to read, and easier to edit. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202371 91177308-0d34-0410-b5e6-96231b3b80d8
* [docs] Delete tons of bad information in the requirements section of theChandler Carruth2014-02-27
| | | | | | | | | | | | | | | | | | | | | | | getting started guide. Some highlights: - I heard there was this Clang compiler that you could use for your host compiler. Not sure though. - We no longer have a GCC frontend with weird build restrictions. - Windows is doing a bit better than partially supported. - We nuked everything to do with itanium. - SPUs? Really? - Xcode 2.5 and gcc 4.0.1 are really not a concern -- they don't work. - OMG, we actually tried building LLVM on Alpha? Really? - PowerPC works pretty well these days. There is still a lot of stuff here I'm pretty dubious about, but I nuked most of what was actively misleading, out of date, or patently wrong. Some of it (mingw stuff especially) isn't really lacking, its just that the comments here were actively wrong. Hopefully folks that know those platforms can add back correct / modern information. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202370 91177308-0d34-0410-b5e6-96231b3b80d8
* Add a note to documentation that Clang + libstdc++ 4.7.2 can not be used to ↵Dmitri Gribenko2014-02-04
| | | | | | build LLD. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@200758 91177308-0d34-0410-b5e6-96231b3b80d8
* Update the Python version. And Perl isn't used anymore.Bill Wendling2013-10-27
| | | | | | PR17608 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@193491 91177308-0d34-0410-b5e6-96231b3b80d8
* Add missing releases.Bill Wendling2013-10-09
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@192304 91177308-0d34-0410-b5e6-96231b3b80d8
* Add links to cross-compilation docs from getting startedRenato Golin2013-09-26
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@191425 91177308-0d34-0410-b5e6-96231b3b80d8
* Nuke the hilariously out of date suggestion to unpack llvm-gcc 4.2 asChandler Carruth2013-09-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | part of getting started with LLVM. The LLVM getting started document is in woeful need of attention. I may get to some of this, but some random notes for folks interested: 1) We need to separate the getting started steps for folks who are interested in the core LLVM libs and nothing else, folks interested in a nifty C++ toolchain and nothing else, and folks interested in both. 2) We should include documentation for both release archives, svn, and git in equal portion, and we should document all of the various repositories of interest: llvm, clang, clang-tools-extra, compiler-rt, lld, libcxx, test-suite. 3) We should document the CMake build. We should probably document the CMake build first, and give a fall-back set of docs for the Makefile build for the use cases where that is still the preferred solution. This would more closely match the use cases that folks in the open source community are likely to have, and would remove a point of discrepancy between Linux, Windows, and Mac instructions. 4) Probably a ton of other modernization stuff that I've not thought of here. Anyways, if anyone at all is interested, please help clean up this document. It is much needed. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189732 91177308-0d34-0410-b5e6-96231b3b80d8
* [typo] An LLVM.Daniel Dunbar2013-08-16
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@188589 91177308-0d34-0410-b5e6-96231b3b80d8
* Remove the mblaze backend from llvm.Rafael Espindola2013-07-25
| | | | | | Approval in here http://lists.cs.uiuc.edu/pipermail/llvmdev/2013-July/064169.html git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@187145 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix documentation on the path to Bitcode reader/writerMichael Liao2013-06-11
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@183761 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix typo in docs/GettingStarted.rst.Rui Ueyama2013-05-22
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@182496 91177308-0d34-0410-b5e6-96231b3b80d8
* [SystemZ] Add configure bitsUlrich Weigand2013-05-06
| | | | | | | | | | | | This patch wires up the SystemZ target in configure, so that it can now be built using --enable-targets=systemz. It is not yet included in the default build (--enable-targets=all); this will be done by a follow-up patch. Patch by Richard Sandiford. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@181208 91177308-0d34-0410-b5e6-96231b3b80d8
* Updated GettingStarted.rst so that it references utils/git-svn for git-svnup ↵Michael Gottesman2013-04-26
| | | | | | instead of catting it into the documentation itself. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@180589 91177308-0d34-0410-b5e6-96231b3b80d8
* Add basic zlib support to LLVM. This would allow to use ↵Alexey Samsonov2013-04-23
| | | | | | compression/uncompression in selected LLVM tools. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@180083 91177308-0d34-0410-b5e6-96231b3b80d8
* Correct spelling of Git.Thomas Schwinge2013-03-28
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@178254 91177308-0d34-0410-b5e6-96231b3b80d8
* Documentation: Replace dead link for binfmt_miscDmitri Gribenko2013-03-25
| | | | | | | Patch by Thomas Schwinge. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@177876 91177308-0d34-0410-b5e6-96231b3b80d8
* GettingStarted: Add Git clone instructions for compiler-rt and test-suiteTobias Grosser2013-03-24
| | | | | | Contributed-by: Thomas Schwinge <thomas@codesourcery.com> git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@177841 91177308-0d34-0410-b5e6-96231b3b80d8
* Adding ARM as supported architectureRenato Golin2013-02-26
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@176096 91177308-0d34-0410-b5e6-96231b3b80d8
* GCC 4.6.3 O3 miscompiles on ARMRenato Golin2013-02-26
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@176090 91177308-0d34-0410-b5e6-96231b3b80d8
* Fixed typo.Michael Gottesman2013-01-25
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@173478 91177308-0d34-0410-b5e6-96231b3b80d8
* Added new section to the git-svn getting started section that provides aMichael Gottesman2013-01-25
| | | | | | | custom git script called git-svnup which handles all of the work of using the git-mirrors/keeping the git-svn numbers in sync. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@173472 91177308-0d34-0410-b5e6-96231b3b80d8
* Documentation: remove all mentions of DejaGNU and TclDmitri Gribenko2013-01-18
| | | | | | | We don't have DejaGNU tests now. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172836 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Fix long standing linking antipattern.Sean Silva2013-01-11
| | | | | | | | | Before we learned about :doc:, we used :ref: and put a dummy link at the top of each page. Don't do that anymore. This fixes PR14891 as a special case. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172162 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: fix broken link.Sean Silva2013-01-10
| | | | | | PR14889 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172046 91177308-0d34-0410-b5e6-96231b3b80d8
* Documentation: add a note that Clang on Mageia 2 can not find libstdc++ headersDmitri Gribenko2013-01-07
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171729 91177308-0d34-0410-b5e6-96231b3b80d8
* Documentation: add clang 3.0 + libstdc++ 4.7.x as a known bad combination thatDmitri Gribenko2013-01-06
| | | | | | | is actually used by a few Linux distributions git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171671 91177308-0d34-0410-b5e6-96231b3b80d8
* Add reference to dcommit on GettingStartedRenato Golin2013-01-06
| | | | | | Signed-off-by: Renato Golin <renato.golin@linaro.org> git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171642 91177308-0d34-0410-b5e6-96231b3b80d8
* GettingStarted: improve formatting and document that configure checks forDmitri Gribenko2013-01-05
| | | | | | | 'clang' to use it as the compiler. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171630 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Show TOC for GettingStarted.rst.Sean Silva2012-12-20
| | | | | | | | | | This is a pretty lengthy document, so put the table of contents in your face so that it's easier to scope out the content. This document is a mess currently and needs to be refactored/revised/split-up. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170646 91177308-0d34-0410-b5e6-96231b3b80d8
* Documentation: use a 'console' highlighter for terminal output examples. ThisDmitri Gribenko2012-12-12
| | | | | | | gives a nicer output than 'bash'. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169979 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: [CMake] Add Xcode to the list of project formats CMake can generate.NAKAMURA Takumi2012-11-27
| | | | | | Suggested by Sean McBride, thanks! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168745 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Fix highlighting.Sean Silva2012-11-20
| | | | | | .git/config was marked as "bash" instead of "ini". git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168365 91177308-0d34-0410-b5e6-96231b3b80d8
* Documentation: fix broken link.Dmitri Gribenko2012-11-18
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168285 91177308-0d34-0410-b5e6-96231b3b80d8
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-29 03:46:01 +0000