aboutsummaryrefslogtreecommitdiff
path: root/llvm/docs/GettingStarted.rst
AgeCommit message (Collapse)AuthorFilesLines
2016-05-31[CMake] Update to requiring CMake 3.4.3Chris Bieneman1-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
2016-05-05Remove bit-rotten CppBackend.James Y Knight1-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
2016-03-28docs: Fix footnote after r260042.Nico Weber1-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
2016-03-28docs: Try to remove weird linebreak from generated html.Nico Weber1-2/+2
llvm-svn: 264654
2016-03-28docs: Update Ninja link, also fix link syntax.Nico Weber1-1/+1
llvm-svn: 264648
2016-02-07[docs] Remove now confusing references to cofigure/autoconfPhilip Reames1-10/+1
llvm-svn: 260042
2016-02-07[docs] Wordsmithing to program layout descriptio in GettingStartedPhilip Reames1-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
2016-02-07[docs] Clarify disk space usage of debug buildsPhilip Reames1-8/+9
llvm-svn: 260039
2016-02-07[docs] Remove a stale and confusing section from GettingStartedPhilip Reames1-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
2016-02-06[docs] Warn against slow serial buildsPhilip Reames1-0/+3
llvm-svn: 260006
2016-02-06[docs] Clarify a couple of getting started issues identified during SprintPhilip Reames1-2/+9
llvm-svn: 260003
2016-01-30[docs] Remove references to autotools build.Alexey Samsonov1-5/+3
llvm-svn: 259280
2016-01-14[docs] Improve the documentation on committing code reviewed onDan Liew1-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
2016-01-04Update docs to recommend CMake >= v3.2.Eric Christopher1-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
2015-12-17[docs] Motivate ninja in GettingStarted.rstVedant Kumar1-1/+1
llvm-svn: 255924
2015-12-10[OPENMP] Make -fopenmp to turn on OpenMP support by default.Alexey Bataev1-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
2015-12-04Fix incorrect quote. NFCPete Cooper1-1/+1
llvm-svn: 254775
2015-08-05Update GettingStarted docs list of LLVM_TARGETS_TO_BUILD to match cmake.Pete Cooper1-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
2015-08-04[GettingStarted.rst] Commit the right patch.Sean Silva1-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
2015-08-03Docs: s/Sanitiser/Sanitizer/ for consistencyMehdi Amini1-4/+4
From: Mehdi Amini <mehdi.amini@apple.com> llvm-svn: 243918
2015-08-03GettingStarted.rst: Add info about building sanitizersMehdi Amini1-2/+19
From: Erik de Castro Lopo <erikd@qti.qualcomm.com> llvm-svn: 243917
2015-08-03docs/GettingStarted.rst: Whitespace onlyMehdi Amini1-24/+24
From: Erik de Castro Lopo <erikd@qti.qualcomm.com> llvm-svn: 243916
2015-07-01Getting started docs: https, and check signatureJF Bastien1-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
2015-06-13R600 -> AMDGPU renameTom Stellard1-1/+1
llvm-svn: 239657
2015-03-14A few minor updates based on feedback from Justin and a few things I thought ↵Chris Bieneman1-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
2015-03-13Updating GettingStarted documentation to reference CMake as the preferred ↵Chris Bieneman1-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
2015-02-15Update the docs to require at least MSVC 2013.Benjamin Kramer1-2/+2
llvm-svn: 229323
2014-12-12Require python 2.7.Rafael Espindola1-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
2014-10-29VMCore was renamed to IR long time agoSeo Sanghyeon1-1/+1
llvm-svn: 220838
2014-08-14Delete support for AuroraUX.Rafael Espindola1-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
2014-08-01docs: Strongly recommend setting rpath when using a local GCC toolchainReid Kleckner1-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
2014-07-17Drop the udis86 wrapper from llvm::sysAlp Toker1-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
2014-05-30fixed more typosSanjay Patel1-2/+2
llvm-svn: 209921
2014-05-30added link to CMake pageSanjay Patel1-3/+4
llvm-svn: 209918
2014-05-30fixed typoSanjay Patel1-1/+1
llvm-svn: 209916
2014-05-29Sync list of targets with configure's realityJeroen Ketema1-8/+6
llvm-svn: 209855
2014-03-12Remove projects/sample.Rafael Espindola1-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
2014-03-02[docs] Fix some Sphinx warnings.Sean Silva1-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
2014-02-28add missing 3.4 releaseGabor Greif1-0/+1
llvm-svn: 202531
2014-02-28[docs] Tweak the example to match what is apparantly the desired formChandler Carruth1-10/+10
for the style templates we're using. llvm-svn: 202494
2014-02-28[docs] Switch to external hyperlink references. Much more readable andChandler Carruth1-16/+19
hopefully easier to get the formatting right for ReST. llvm-svn: 202493
2014-02-28[docs] Fix my links to use the correct ReST syntax.Chandler Carruth1-3/+3
llvm-svn: 202490
2014-02-28[docs] Fix 80-column wrap that I messed up.Chandler Carruth1-5/+5
llvm-svn: 202489
2014-02-28[docs] Tweak discussion of BSDs based on feedback from Roman Divacky.Chandler Carruth1-3/+4
FreeBSD 10.0 and newer have a modern Clang toolchain that should work well. llvm-svn: 202488
2014-02-28[docs] Add a big section with details about how to go about acquiringChandler Carruth1-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
2014-02-27[docs] Stop advertising 'make update'. It isn't implemented in CMake andChandler Carruth1-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
2014-02-27[docs] Actually spell out the new version requirements for the host C++Chandler Carruth1-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
2014-02-27[docs] Clean up some of the required software to not mention irrelevantChandler Carruth1-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
2014-02-27[docs] Switch this table to the simple form as well. No content changed.Chandler Carruth1-23/+14
llvm-svn: 202372
2014-02-27[docs] Switch to the incredibly simpler "simple table" form. It nowChandler Carruth1-29/+17
actually looks like the table on the webpage and is entertainingly smaller, easier to read, and easier to edit. llvm-svn: 202371
generated by cgit v1.1 at 2025-10-18 10:18:11 +0000