summaryrefslogtreecommitdiffstats
path: root/llvm/docs/GettingStarted.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* [CMake] Update to requiring CMake 3.4.3Chris Bieneman2016-05-311-3/+5
| | | | | | | | | | | | | | Summary: This is as per the discussions on developer lists: http://lists.llvm.org/pipermail/llvm-dev/2016-April/098780.html http://lists.llvm.org/pipermail/llvm-dev/2016-May/100058.html Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D20822 llvm-svn: 271325
* Remove bit-rotten CppBackend.James Y Knight2016-05-051-3/+3
| | | | | | | | | | | | | | | | | This backend was supposed to generate C++ code which will re-construct the LLVM IR passed as input. This seems to me to have very marginal usefulness in the first place. However, the code has never been updated to use IRBuilder, which makes its current value negative -- people who look at the output may be steered to use the *wrong* C++ APIs to construct IR. Furthermore, it's generated code that doesn't compile since at least 2013. Differential Revision: http://reviews.llvm.org/D19942 llvm-svn: 268631
* docs: Fix footnote after r260042.Nico Weber2016-03-281-2/+1
| | | | | | | | r260042 removed a footnote referring to autoconf, but it left around one item still referring to that footnote (libtool), and it didn't renumber the later footnote reference. llvm-svn: 264663
* docs: Try to remove weird linebreak from generated html.Nico Weber2016-03-281-2/+2
| | | | llvm-svn: 264654
* docs: Update Ninja link, also fix link syntax.Nico Weber2016-03-281-1/+1
| | | | llvm-svn: 264648
* [docs] Remove now confusing references to cofigure/autoconfPhilip Reames2016-02-071-10/+1
| | | | llvm-svn: 260042
* [docs] Wordsmithing to program layout descriptio in GettingStartedPhilip Reames2016-02-071-97/+63
| | | | | | | | This just incrementally improves what was already there; it's questionable whether this content belongs in the getting started guide at all. Patch by Ben Nathanson w/permission w/minor edtis by me. llvm-svn: 260040
* [docs] Clarify disk space usage of debug buildsPhilip Reames2016-02-071-8/+9
| | | | llvm-svn: 260039
* [docs] Remove a stale and confusing section from GettingStartedPhilip Reames2016-02-071-19/+2
| | | | | | | | The mentioned environment variable doesn't appear to have any use in the LLVM repository. If it is still relevant for clang, we can consider adding it to the clang getting started page. Patch inspired by documentation work by Ben Nathanson at the LLVM Bloomberg sprint. llvm-svn: 260037
* [docs] Warn against slow serial buildsPhilip Reames2016-02-061-0/+3
| | | | llvm-svn: 260006
* [docs] Clarify a couple of getting started issues identified during SprintPhilip Reames2016-02-061-2/+9
| | | | llvm-svn: 260003
* [docs] Remove references to autotools build.Alexey Samsonov2016-01-301-5/+3
| | | | llvm-svn: 259280
* [docs] Improve the documentation on committing code reviewed onDan Liew2016-01-141-0/+2
| | | | | | | | | | | | | | | | | | | | | | Phabricator to trunk. The previous documentation had a few issues: * It did not make it explicit that code could be committed without using the Arcanist tool and how this should be done. * There was also an implicit assumption on using Subversion rather than git-svn in the example using Arcanist. The documentation now explicitly mentions both cases and details how to commit to trunk in each case. Reviewers: klimek, probinson Subscribers: probinson, nwilson, reames, llvm-commits Differential Revision: http://reviews.llvm.org/D15801 llvm-svn: 257764
* Update docs to recommend CMake >= v3.2.Eric Christopher2016-01-041-0/+2
| | | | | | | | | | CMake v3.2 or newer is necessary to get interactive output when running Lit via Ninja. Otherwise Ninja will buffer Lit's output, which makes for a crummy experience -- you can't tell if your tests are hung! Patch by Justin Lebar! llvm-svn: 256791
* [docs] Motivate ninja in GettingStarted.rstVedant Kumar2015-12-171-1/+1
| | | | llvm-svn: 255924
* [OPENMP] Make -fopenmp to turn on OpenMP support by default.Alexey Bataev2015-12-101-2/+15
| | | | | | | Patch turns on OpenMP support in clang by default after fixing OpenMP buildbots. Differential Revision: http://reviews.llvm.org/D13802 llvm-svn: 255222
* Fix incorrect quote. NFCPete Cooper2015-12-041-1/+1
| | | | llvm-svn: 254775
* Update GettingStarted docs list of LLVM_TARGETS_TO_BUILD to match cmake.Pete Cooper2015-08-051-3/+3
| | | | | | | | | | Since the docs were written, we've added the BPF backend to the list. Updating the docs to take this in to account. Also sorted them to match cmake while I was changing these lines. Reviewed by Chris B. llvm-svn: 244123
* [GettingStarted.rst] Commit the right patch.Sean Silva2015-08-041-4/+2
| | | | | | | | | Looks like the rebased version that Mehdi committed didn't incorporate the latest changes. Patch by Erik de Castro Lopo <erikd@mega-nerd.com>! llvm-svn: 243942
* Docs: s/Sanitiser/Sanitizer/ for consistencyMehdi Amini2015-08-031-4/+4
| | | | | From: Mehdi Amini <mehdi.amini@apple.com> llvm-svn: 243918
* GettingStarted.rst: Add info about building sanitizersMehdi Amini2015-08-031-2/+19
| | | | | From: Erik de Castro Lopo <erikd@qti.qualcomm.com> llvm-svn: 243917
* docs/GettingStarted.rst: Whitespace onlyMehdi Amini2015-08-031-24/+24
| | | | | From: Erik de Castro Lopo <erikd@qti.qualcomm.com> llvm-svn: 243916
* Getting started docs: https, and check signatureJF Bastien2015-07-011-1/+5
| | | | | | | | | | | | | | Summary: Download should be over https, not insecure ftp at least for the signature and key files. The signature should also get verified. Test Plan: None Reviewers: chandlerc Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D10845 llvm-svn: 241138
* R600 -> AMDGPU renameTom Stellard2015-06-131-1/+1
| | | | llvm-svn: 239657
* A few minor updates based on feedback from Justin and a few things I thought ↵Chris Bieneman2015-03-141-25/+12
| | | | | | | | | | | | were missing. * Moved autotools configure & build example out of "Getting Started Quickly (A Summary)" and into BuildingLLVMWithAutoTools. * Removed the annotations that CMake is the recommended process and Autotools is alternate. * Added brief documentation about build targets under "Getting Started Quickly..." * Added Overview text to BuildingLLVMWithAutotools * Fixed up a broken link. llvm-svn: 232278
* Updating GettingStarted documentation to reference CMake as the preferred ↵Chris Bieneman2015-03-131-205/+153
| | | | | | | | | | | | | | way to build LLVM. Reviewers: chandlerc, samsonov, echristo Reviewed By: samsonov Subscribers: emaste, joker.eph, llvm-commits Differential Revision: http://reviews.llvm.org/D8046 llvm-svn: 232135
* Update the docs to require at least MSVC 2013.Benjamin Kramer2015-02-151-2/+2
| | | | llvm-svn: 229323
* Require python 2.7.Rafael Espindola2014-12-121-1/+1
| | | | | | | | | | | | | We were already requiring 2.5, which meant that people on old linux distros had to upgrade anyway. Requiring python 2.6 will make supporting 3.X easier as we can use the 3.X exception syntax. According to the discussion on llvmdev, there is not much value is requiring just 2.6, we may as well just require 2.7. llvm-svn: 224129
* VMCore was renamed to IR long time agoSeo Sanghyeon2014-10-291-1/+1
| | | | llvm-svn: 220838
* Delete support for AuroraUX.Rafael Espindola2014-08-141-1/+0
| | | | | | | | | auroraux.org is not resolving. I will add this to the release notes as soon as I figure out where to put the 3.6 release notes :-) llvm-svn: 215645
* docs: Strongly recommend setting rpath when using a local GCC toolchainReid Kleckner2014-08-011-4/+17
| | | | | | | | | | | | Users keep emailing us about the difficulties of getting LD_LIBRARY_PATH into their environment, which should be completely unecessary. Try to strengthen the rpath recommentation by putting in an example cmake invocation. Speaking of which, we might want to make CMake the recommended build system in GettingStarted.html. llvm-svn: 214565
* Drop the udis86 wrapper from llvm::sysAlp Toker2014-07-171-7/+0
| | | | | | | | This optional dependency on the udis86 library was added some time back to aid JIT development, but doesn't make much sense to link into LLVM binaries these days. llvm-svn: 213300
* fixed more typosSanjay Patel2014-05-301-2/+2
| | | | llvm-svn: 209921
* added link to CMake pageSanjay Patel2014-05-301-3/+4
| | | | llvm-svn: 209918
* fixed typoSanjay Patel2014-05-301-1/+1
| | | | llvm-svn: 209916
* Sync list of targets with configure's realityJeroen Ketema2014-05-291-8/+6
| | | | llvm-svn: 209855
* Remove projects/sample.Rafael Espindola2014-03-121-2/+1
| | | | | | | | | | | | | | | 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. llvm-svn: 203728
* [docs] Fix some Sphinx warnings.Sean Silva2014-03-021-3/+4
| | | | | | | | | | | | | | | | | | | | | | | 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. llvm-svn: 202603
* add missing 3.4 releaseGabor Greif2014-02-281-0/+1
| | | | llvm-svn: 202531
* [docs] Tweak the example to match what is apparantly the desired formChandler Carruth2014-02-281-10/+10
| | | | | | for the style templates we're using. llvm-svn: 202494
* [docs] Switch to external hyperlink references. Much more readable andChandler Carruth2014-02-281-16/+19
| | | | | | hopefully easier to get the formatting right for ReST. llvm-svn: 202493
* [docs] Fix my links to use the correct ReST syntax.Chandler Carruth2014-02-281-3/+3
| | | | llvm-svn: 202490
* [docs] Fix 80-column wrap that I messed up.Chandler Carruth2014-02-281-5/+5
| | | | llvm-svn: 202489
* [docs] Tweak discussion of BSDs based on feedback from Roman Divacky.Chandler Carruth2014-02-281-3/+4
| | | | | | | FreeBSD 10.0 and newer have a modern Clang toolchain that should work well. llvm-svn: 202488
* [docs] Add a big section with details about how to go about acquiringChandler Carruth2014-02-281-0/+65
| | | | | | | | | | | | 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. llvm-svn: 202486
* [docs] Stop advertising 'make update'. It isn't implemented in CMake andChandler Carruth2014-02-271-4/+0
| | | | | | | | | | | 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". llvm-svn: 202430
* [docs] Actually spell out the new version requirements for the host C++Chandler Carruth2014-02-271-79/+19
| | | | | | | | | | | | | | | | | | | 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. =] llvm-svn: 202375
* [docs] Clean up some of the required software to not mention irrelevantChandler Carruth2014-02-271-12/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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. llvm-svn: 202373
* [docs] Switch this table to the simple form as well. No content changed.Chandler Carruth2014-02-271-23/+14
| | | | llvm-svn: 202372
* [docs] Switch to the incredibly simpler "simple table" form. It nowChandler Carruth2014-02-271-29/+17
| | | | | | | actually looks like the table on the webpage and is entertainingly smaller, easier to read, and easier to edit. llvm-svn: 202371
OpenPOWER on IntegriCloud