summaryrefslogtreecommitdiffstats
path: root/llvm/docs/GettingStarted.rst
Commit message (Collapse)AuthorAgeFilesLines
* [docs] Fix duplicate explicit target name: developer policyJim Lin2020-01-081-2/+2
|
* [docs] Improve HowTo commit changes from gitJim Lin2020-01-081-1/+5
| | | | | | | | | | | | | | Summary: As a novice here I tried to `git push` my changes for a while before figuring out the correct workflow which is described on other pages. This small change doesn't reduce redundancy between those pages, but at least readers can follow the links now. Reviewers: Kokan, Jim Reviewed By: Kokan, Jim Subscribers: riccibruno, kiszk, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D72077
* [docs] Remove `git llvm push` and `git llvm revert` from GettingStartedJustin Bogner2019-12-171-42/+14
| | | | | | These sections aren't accurate since the github move. Differential Revision: https://reviews.llvm.org/D71640
* [cmake] Remove LLVM_{BUILD,LINK}_LLVM_DYLIB options on WindowsTom Stellard2019-11-081-1/+2
| | | | | | | | | | | | | | Summary: The options aren't supported so they can be removed. Reviewers: beanz, smeenai, compnerd Reviewed By: compnerd Subscribers: mgorny, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D69877
* [docs] Add Mips as a supported architecture in GettingStarted.rstSimon Atanasyan2019-10-241-0/+1
| | | | | | Patch by Miloš Stojanović Differential Revision: https://reviews.llvm.org/D69380
* Improve language in GettingStarted.rstMeike Baumgärtner2019-10-231-21/+16
| | | | | | | This patch was reviewed and approved by chandlerc. "Getting Started with the LLVM System" is the first point of contact for many newcomers in the LLVM community. * Make the first two paragraphs more welcoming * Use more inclusive language
* [docs] Fix sphinx doc generation errorsJordan Rupprecht2019-08-141-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Summary: Errors fixed: - GettingStarted: Duplicate explicit target name: "cmake" - GlobalISel: Unexpected indentation - LoopTerminology: Explicit markup ends without a blank line; unexpected unindent - ORCv2: Definition list ends without a blank line; unexpected unindent - Misc: document isn't included in any toctree Verified that a clean docs build (`rm -rf docs/ && ninja docs-llvm-html`) passes with no errors. Spot checked the individual pages to make sure they look OK. Reviewers: thakis, dsanders Reviewed By: dsanders Subscribers: arphaman, llvm-commits, lhames, rovka, dsanders, reames Tags: #llvm Differential Revision: https://reviews.llvm.org/D66183 llvm-svn: 368932
* Remove minimum toolchain soft-errorJF Bastien2019-08-141-9/+0
| | | | | | | | | | | | | | | | | | | | | | | Summary: Back in January I changed the minimum toolchain version required to build clang and LLVM: D57264. Since then we've release LLVM 8, following [our process](http://llvm.org/docs/DeveloperPolicy.html#toolchain) it's therefore now a good time to remove the soft-error and officially deprecate older toolchains. I tried this out last Tursday night to see if any bots complained, and I saw no complaints. I also manually audited bots and didn't see any bot that should break, but their toolchain information is unreliable and some bots are offline. Once this patch stick we'll move to C++14 as we've [already agreed](http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html). Subscribers: mgorny, jkorous, dexonsmith, llvm-commits, EricWF, thakis, chandlerc Tags: #llvm Differential Revision: https://reviews.llvm.org/D66188 llvm-svn: 368799
* [docs] Add cmake to Software requirementsDiana Picus2019-07-311-1/+3
| | | | | | | | | Add cmake to the list of packages required for compiling LLVM. Also move make to the bottom of the list and mark it as optional. Differential Revision: https://reviews.llvm.org/D65438 llvm-svn: 367395
* [CMake] Don't set Python_ADDITIONAL_VERSIONSJonas Devlieghere2019-07-181-0/+5
| | | | | | | | | | | | | | | | | | | | | | Until recently, Python_ADDITIONAL_VERSIONS was used to limit LLVM's Python support to 2.7. Now that both LLVM and LLDB both support Python 3, there's no longer a need to put an arbitrary limit on this. However, instead of removing the variable, r365692 expanded the list, which has the (presumably unintentional) side-effect of expression preference for Python 3. Instead, as Michal proposed in the original code review, we should just not set the list at all, and let CMake pick whatever Python interpreter you have in your path. This patch removes the Python_ADDITIONAL_VERSIONS variable in llvm, clang and lld. I've also updated the docs with the default behavior and how to force a different Python version to be used. Differential revision: https://reviews.llvm.org/D64894 llvm-svn: 366447
* Retire VS2015 SupportSimon Pilgrim2019-07-091-2/+2
| | | | | | | | | | As proposed here: https://lists.llvm.org/pipermail/llvm-dev/2019-June/133147.html This patch raises the minimum supported version to build LLVM/Clang to Visual Studio 2017. Differential Revision: https://reviews.llvm.org/D64326 llvm-svn: 365452
* [docs] Add 'git llvm revert' to getting started guideJordan Rupprecht2019-06-101-0/+20
| | | | | | | | | | | | | | Summary: This documents `git llvm revert rNNNNNN` in the getting started guide for broader visibility. Reviewers: jyknight, mehdi_amini Subscribers: llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63023 llvm-svn: 362966
* [Docs] Modernize references to macOSJ. Ryan Stinnett2019-05-301-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | Summary: This updates all places in documentation that refer to "Mac OS X", "OS X", etc. to instead use the modern name "macOS" when no specific version number is mentioned. If a specific version is mentioned, this attempts to use the OS name at the time of that version: * Mac OS X for 10.0 - 10.7 * OS X for 10.8 - 10.11 * macOS for 10.12 - present Reviewers: JDevlieghere Subscribers: mgorny, christof, arphaman, cfe-commits, lldb-commits, libcxx-commits, llvm-commits Tags: #clang, #lldb, #libc, #llvm Differential Revision: https://reviews.llvm.org/D62654 llvm-svn: 362113
* Stop enabling clang-tools-extra automatically when clang is in ↵Nico Weber2019-02-141-2/+2
| | | | | | | | | | | | | | LLVM_ENABLE_PROJECTS If you want to build clang-tools-extra with monorepo, just add it to LLVM_ENABLE_PROJECTS like with other projects. See also "Separating clang-tools-extra from clang in LLVM_ENABLE_PROJECTS" on cfe-dev. Differential Revision: https://reviews.llvm.org/D58157 llvm-svn: 354057
* Bump minimum toolchain versionJF Bastien2019-02-071-17/+29
| | | | | | | | | | | | | | | Summary: The RFC on moving past C++11 got good traction: http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html This patch therefore bumps the toolchain versions according to our policy: llvm.org/docs/DeveloperPolicy.html#toolchain Subscribers: mgorny, jkorous, dexonsmith, llvm-commits, mehdi_amini, jyknight, rsmith, chandlerc, smeenai, hans, reames, lattner, lhames, erichkeane Differential Revision: https://reviews.llvm.org/D57264 llvm-svn: 353374
* Revert "Bump minimum toolchain version"JF Bastien2019-02-021-29/+17
| | | | | | | | | | | Reverting D57264 again, it looks like we're down to two bots that need fixing: polly-amd64-linux polly-arm-linux They both have old versions of libstdc++ and recent clang. llvm-svn: 352954
* Bump minimum toolchain versionJF Bastien2019-02-021-17/+29
| | | | | | | | | | | | | | | Summary: The RFC on moving past C++11 got good traction: http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html This patch therefore bumps the toolchain versions according to our policy: llvm.org/docs/DeveloperPolicy.html#toolchain Subscribers: mgorny, jkorous, dexonsmith, llvm-commits, mehdi_amini, jyknight, rsmith, chandlerc, smeenai, hans, reames, lattner, lhames, erichkeane Differential Revision: https://reviews.llvm.org/D57264 llvm-svn: 352951
* Revert "Bump minimum toolchain version"JF Bastien2019-02-011-29/+17
| | | | | | Looks like we still have a few bots that are sad. Let try to get them fixed! llvm-svn: 352835
* Bump minimum toolchain versionJF Bastien2019-02-011-17/+29
| | | | | | | | | | | | | | | Summary: The RFC on moving past C++11 got good traction: http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html This patch therefore bumps the toolchain versions according to our policy: llvm.org/docs/DeveloperPolicy.html#toolchain Subscribers: mgorny, jkorous, dexonsmith, llvm-commits, mehdi_amini, jyknight, rsmith, chandlerc, smeenai, hans, reames, lattner, lhames, erichkeane Differential Revision: https://reviews.llvm.org/D57264 llvm-svn: 352834
* Revert "Bump minimum toolchain version"JF Bastien2019-01-311-29/+17
| | | | | | | | A handful of bots are still breaking, either because I missed them in my audit, they were offline, or something else. I'm contacting their authors, but I'll revert for now and re-commit later. llvm-svn: 352814
* Bump minimum toolchain versionJF Bastien2019-01-311-17/+29
| | | | | | | | | | | | | | | Summary: The RFC on moving past C++11 got good traction: http://lists.llvm.org/pipermail/llvm-dev/2019-January/129452.html This patch therefore bumps the toolchain versions according to our policy: llvm.org/docs/DeveloperPolicy.html#toolchain Subscribers: mgorny, jkorous, dexonsmith, llvm-commits, mehdi_amini, jyknight, rsmith, chandlerc, smeenai, hans, reames, lattner, lhames, erichkeane Differential Revision: https://reviews.llvm.org/D57264 llvm-svn: 352811
* [docs] Remove extra character from git URL in Getting Started guide.Douglas Yung2019-01-241-1/+1
| | | | llvm-svn: 352005
* Document toolchain update policyJF Bastien2019-01-211-7/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | Summary: Capture the current agreed-upon toolchain update policy based on the following discussions: - LLVM dev meeting 2018 BoF "Migrating to C++14, and beyond!" llvm.org/devmtg/2018-10/talk-abstracts.html#bof3 - A Short Policy Proposal Regarding Host Compilers lists.llvm.org/pipermail/llvm-dev/2018-May/123238.html - Using C++14 code in LLVM (2018) lists.llvm.org/pipermail/llvm-dev/2018-May/123182.html - Using C++14 code in LLVM (2017) lists.llvm.org/pipermail/llvm-dev/2017-October/118673.html - Using C++14 code in LLVM (2016) lists.llvm.org/pipermail/llvm-dev/2016-October/105483.html - Document and Enforce new Host Compiler Policy llvm.org/D47073 - Require GCC 5.1 and LLVM 3.5 at a minimum llvm.org/D46723 Subscribers: jkorous, dexonsmith, llvm-commits Differential Revision: https://reviews.llvm.org/D56819 llvm-svn: 351765
* Update GettingStarted guide to recommend that people use the newJames Y Knight2019-01-141-374/+153
| | | | | | | | | | | | | | | | | | | | | official Git repository. Remove the directions for using git-svn, and demote the prominence of the svn instructions. Also, fix a few other issues while I'm in there: * Mention LLVM_ENABLE_PROJECTS more. * Getting started doesn't need to mention test-suite, but should mention clang and the other projects. * Remove mentions of "configure", since that's long gone. I've also adjusted a few other mentions of svn to point to github, but have not done so comprehensively. Differential Revision: https://reviews.llvm.org/D56654 llvm-svn: 351130
* [docs] Remove reference to makellvm which was removed in rL329041Fangrui Song2018-09-271-9/+0
| | | | llvm-svn: 343165
* [doc] Fix Getting Started typo.Joel Galenson2018-07-301-1/+1
| | | | | | | | This makes it easier for someone to copy-paste this line, change the path, and run the command. Differential Revision: https://reviews.llvm.org/D49201 llvm-svn: 338254
* Document the git config for Windows to do line-endings correctly.Paul Robinson2018-06-271-2/+10
| | | | | | Differential Revision: https://reviews.llvm.org/D48494 llvm-svn: 335775
* GettingStarted.rst: Fix 'If you you' typo (PR37787)Hans Wennborg2018-06-131-1/+1
| | | | llvm-svn: 334584
* [NFC] fix trivial typos in comments and documentsHiroshi Inoue2018-01-291-1/+1
| | | | | | "to to" -> "to" llvm-svn: 323628
* [NFC] fix trivial typos in comments and documentsHiroshi Inoue2018-01-261-1/+1
| | | | | | "in in" -> "in", "on on" -> "on" etc. llvm-svn: 323508
* docs/GettingStarted.rst: Update the list of release versions and tagsHans Wennborg2017-11-301-26/+5
| | | | llvm-svn: 319502
* Added instructions for obtaining clang-tools-extra to the Getting Started page.Aaron Ballman2017-10-241-0/+6
| | | | llvm-svn: 316468
* Updated 'Getting Started' to use valid git links (added trailing slashes)Mitch Phillips2017-10-231-33/+33
| | | | | | | | | | | | Reviewers: pcc, asl, tonic Reviewed By: pcc Subscribers: llvm-commits, kcc Differential Revision: https://reviews.llvm.org/D38516 llvm-svn: 316352
* Fix git command line in the Getting Started guide.Rui Ueyama2017-05-151-1/+1
| | | | | | | By default, git creates "llvm-project-20170507" directory, but we want to create "llvm-project" directory. llvm-svn: 303124
* Update instructions for using the experimental monorepoReid Kleckner2017-05-081-2/+2
| | | | llvm-svn: 302459
* Update documentation for the NetBSD targetKamil Rytarowski2017-04-221-0/+2
| | | | | | LLVM is known to work on NetBSD x86 32-bit and 64-bit. llvm-svn: 301081
* Fix GettingStarted.rst statement.Rafael Espindola2017-03-291-1/+1
| | | | | | Patch by Wei-Ren Chen! llvm-svn: 298995
* Document how to fetch monorepo SVN revision notesReid Kleckner2017-03-241-6/+18
| | | | llvm-svn: 298733
* Mention that the Sphinx docs build wants version 1.5 or laterJonathan Roelofs2017-03-201-1/+2
| | | | | | | `misc.highlighting_failure` support was added to `suppress_warnings` in that version, and the warnings-as-errors docs build relies on it. llvm-svn: 298277
* [docs] Add information about how to checkout polly to getting started pageTobias Grosser2017-02-231-0/+6
| | | | llvm-svn: 295974
* Fix GettingStarted doc so that the example build command for cmake ↵Mehdi Amini2017-01-171-1/+1
| | | | | | | | | LLVM_ENABLE_PROJECTS works on linux I tested the previous one on macOS, however building libc++ on Linux requires libcxxabi as well. llvm-svn: 292290
* fix some typos in the docSylvestre Ledru2017-01-141-1/+1
| | | | llvm-svn: 292014
* Add a description how to checkout the LLD repository.Rui Ueyama2017-01-131-0/+6
| | | | | | Differential Revision: https://reviews.llvm.org/D28687 llvm-svn: 291948
* Fix some remaining documentation references to MSVC 2013Reid Kleckner2016-12-151-1/+1
| | | | | | | | MSVC 2015 has been the minimum supported version of VS since October. Differential Revision: https://reviews.llvm.org/D25710 llvm-svn: 289854
* [doc] Add .arcconfig setup to the "how to work with a monorepo" sectionMehdi Amini2016-12-031-0/+11
| | | | llvm-svn: 288562
* [doc] Add documentation about how to use a monorepoMehdi Amini2016-11-071-0/+56
| | | | llvm-svn: 286163
* Revert "Add some facilities to work with a git monorepo (experimental setup)"Mehdi Amini2016-11-071-54/+0
| | | | | | This reverts commit r286123, accidentally commited while testing itself... llvm-svn: 286124
* Add some facilities to work with a git monorepo (experimental setup)Mehdi Amini2016-11-071-0/+54
| | | | | | | | | | | | | | | | | | | | | | | | Summary: Some changes are made to cmake, especially the addition of a new LLVM_ENABLE_PROJECTS option that makes the build system aware of the monorepo directory structure. Also a new script is added in llvm/utils/git-svn/. When present in the $PATH, it enables a `git llvm` command. It is providing at this point only the ability to push from the git monorepo: `git llvm push`. It is intended to evolves with more features, for instance I plan on features like `git llvm show r284955` to help working with sequential revision numbers. The push feature is taken from Justin Lebar's script available here: https://github.com/jlebar/llvm-repo-tools/ Reviewers: jlebar Subscribers: mgorny, modocache, llvm-commits Differential Revision: https://reviews.llvm.org/D26334 llvm-svn: 286123
* Update docs to reflect new minimum MSVC version requirementReid Kleckner2016-10-191-3/+3
| | | | | | | | | | Mailing list discussion about this: http://lists.llvm.org/pipermail/llvm-dev/2016-September/104631.html Code changes to simplify the ifdefs will come next, and can be reverted without affecting the policy if someone needs it. llvm-svn: 284660
* [docs] Increase minimum supported GCC version for building LLVM to 4.8Teresa Johnson2016-10-181-18/+2
| | | | | | | | | | | | | | | | | | | | Summary: The RFC proposal sent to increase the minimum required GCC version to 4.8 received a lot of support. See the following thread: http://lists.llvm.org/pipermail/llvm-dev/2016-October/105955.html, This patch implements that by updating the docs. I believe the references to libstdc++ 4.7 issues can be removed as well, please let me know if that is not the case or if they should be updated a different way. Reviewers: rengolin Subscribers: llvm-commits Differential Revision: https://reviews.llvm.org/D25683 llvm-svn: 284497
OpenPOWER on IntegriCloud