summaryrefslogtreecommitdiffstats
path: root/llvm/docs
Commit message (Collapse)AuthorAgeFilesLines
* Change x86mmx -> x86_mmx in LangRef.rstReid Kleckner2014-03-051-7/+5
| | | | | | | | | | | The correct name of the type in LLVM assembly is "x86_mmx". Also remove the reST label "t_x86mmx" because it was unused anyway. Patch by Manuel Jacob! Differential Revision: http://llvm-reviews.chandlerc.com/D2955 llvm-svn: 202929
* LangRef: Remove stale docs on LLVM types in module structureReid Kleckner2014-03-051-19/+10
| | | | | | | | | The distinction between "identified" and "literal" struct types is fully documented in a later section. Patch by Philip Reames! llvm-svn: 202927
* [Modules] Move ValueMap to the IR library. While this class does notChandler Carruth2014-03-041-1/+1
| | | | | | | | | | | | directly care about the Value class (it is templated so that the key can be any arbitrary Value subclass), it is in fact concretely tied to the Value class through the ValueHandle's CallbackVH interface which relies on the key type being some Value subclass to establish the value handle chain. Ironically, the unittest is already in the right library. llvm-svn: 202824
* Avoid std::function until PR19030 is fixedReid Kleckner2014-03-031-0/+4
| | | | | | | | | We'd like to keep the clang-cl self-host working until we implement MSVC-compatible RTTI. Differential Revision: http://llvm-reviews.chandlerc.com/D2930 llvm-svn: 202758
* Document that std::initializer_list is not always available.Peter Collingbourne2014-03-031-0/+3
| | | | | | Differential Revision: http://llvm-reviews.chandlerc.com/D2923 llvm-svn: 202750
* Add DWARF discriminator support to DILexicalBlocks.Diego Novillo2014-03-031-2/+5
| | | | | | This adds support for emitting discriminators from DILexicalBlocks. llvm-svn: 202736
* C++11: Beware unnecessary copies with autoDuncan P. N. Exon Smith2014-03-031-0/+21
| | | | | | | | It's easy to copy unintentionally when using 'auto', particularly inside range-based for loops. Best practise is to use 'const&' unless there's a good reason not to. llvm-svn: 202729
* Clarify struct usage guidelinesDuncan P. N. Exon Smith2014-03-031-5/+31
| | | | | | | | The current coding standards restrict the use of struct to PODs, but no one has been following them. This patch updates the standards to clarify when structs are dangerous and describe common practice in LLVM. llvm-svn: 202728
* [C++11] Suggest placing callable arguments as the last argument toChandler Carruth2014-03-021-0/+4
| | | | | | | | facilitate the nice formatting of lambdas passed there. Suggested by Chris during review of my lambda additions, and something I strongly agree with. llvm-svn: 202622
* [C++11] Update the coding standards to provide some important guidanceChandler Carruth2014-03-021-4/+126
| | | | | | | | | | about a few constructs in C++11 that are worth starting off in a consistent manner within the codebase. This will be matched with a change to clang-format's LLVM style which will switch the options to support C++11 and use these conventions. llvm-svn: 202620
* remove an old entry whose link is broken anywayChris Lattner2014-03-021-8/+0
| | | | llvm-svn: 202617
* [docs] Fix some Sphinx warnings.Sean Silva2014-03-024-4/+7
| | | | | | | | | | | | | | | | | | | | | | | 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
* [docs] Update the docs to remove my hedging about C++98 vs. C++11. =]Chandler Carruth2014-03-011-17/+16
| | | | | | | The switch has been thrown. While I'm still watching for any failures or problems with this, the documentation can go ahead and move forward. llvm-svn: 202566
* [docs] Clarify that there isn't much to be done other than watch buildChandler Carruth2014-02-281-0/+5
| | | | | | | | | | | | bots when using the standard library facilities. The missing pieces here aren't always in useful discreet chunks. Fortunately, the missing pieces are few and far between, and we can emulate most of them in our headers as needed. Based on feedback from Lang and Dave. llvm-svn: 202548
* Add more whitespace to fix more bullets.Richard Smith2014-02-281-0/+2
| | | | llvm-svn: 202538
* Add whitespace to try to fix bulleted list.Richard Smith2014-02-281-0/+1
| | | | llvm-svn: 202537
* Fix some links to C++11 feature papers in the Coding StandardsBen Langmuir2014-02-281-16/+16
| | | | llvm-svn: 202532
* add missing 3.4 releaseGabor Greif2014-02-281-0/+1
| | | | llvm-svn: 202531
* [docs] Add a section to the coding standards about languages and such.Chandler Carruth2014-02-281-0/+115
| | | | | | | | | | | | | | | | A lot of this is writing down common knowledge and things often communicated on mailing lists and in discussions. It could live in the Programmer's Manual alternatively, but that felt slightly less well-fitting. It also includes (and was motivated by) the section on the relevant language standards for LLVM and the specific features that will be enabled with the switch to C++11. With this, all of the documentation for the C++11 switch is, I think, in place. I plan to flip the switch RSN. =] llvm-svn: 202497
* [docs] A slight tweak to the intro for the golden rule in the codingChandler Carruth2014-02-281-3/+3
| | | | | | | | | | | | | | | | standards. It claims the document intentionally doesn't give fixed standards for brace placement or spacing, and then the document goes on to do precisely that in several places. Instead, try to highlight that even these rules are simply *guidance* which may be trumped by some other circumstance or the local conventions of code. I'm not trying to change the thrust of this part of the document, and if folks think this does so, I'm happy to re-wordsmith it. I just don't want it to be so self-contradicting. llvm-svn: 202495
* [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
* Now that it is possible, use the mangler in IRObjectFile.Rafael Espindola2014-02-281-0/+3
| | | | | | A really simple patch marks the end of a lot of yak shaving :-) llvm-svn: 202463
* [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
* [docs] Delete tons of bad information in the requirements section of theChandler Carruth2014-02-271-45/+14
| | | | | | | | | | | | | | | | | | | | | | | 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. llvm-svn: 202370
* Exception handling docs: Fix a typoMark Seaborn2014-02-271-1/+1
| | | | llvm-svn: 202354
* Exception handling docs: Describe landingpad clauses' meanings in more detailMark Seaborn2014-02-251-6/+55
| | | | | | | | | | | | | | | | The original text is very terse, so I've expanded on it. Specifically, in the original text: * "The selector value is a positive number if the exception matched a type info" -- It wasn't clear that this meant "if the exception matched a 'catch' clause". * "If nothing is matched, the behavior of the program is `undefined`_." -- It's actually implementation-defined in C++ rather than undefined, as the new text explains. llvm-svn: 202209
* Make DisableIntegratedAS a TargetOption.Rafael Espindola2014-02-211-1/+2
| | | | | | | This replaces the old NoIntegratedAssembler with at TargetOption. This is more flexible and will be used to forward clang's -no-integrated-as option. llvm-svn: 201836
* Added release note about making all inline assembly parsed (even for assemblyDaniel Sanders2014-02-201-0/+4
| | | | | | output) when the integrated assembler is enabled. llvm-svn: 201770
* [docs] Clean up some more llvm-gcc stuffSean Silva2014-02-198-18/+14
| | | | | | | | | | Some references to llvm-gcc were so crusty that I wasn't sure how to proceed and so I've left them intact. I also slipped in a quick peephole fix to use a :doc: link instead of raw HTML link. llvm-svn: 201619
* [docs] Nuke some references to llvm-gccSean Silva2014-02-181-9/+9
| | | | | | | From a cursory look it seems like all the described commandline options and such apply to clang just fine, but I'd appreciate a second opinion. llvm-svn: 201616
* PGO: llvm-profdata: tool for merging profilesDuncan P. N. Exon Smith2014-02-172-0/+30
| | | | | | | | | | | | | | | | | | | Introducing llvm-profdata, a tool for merging profile data generated by PGO instrumentation in clang. - The name indicates a file extension of <name>.profdata. Eventually profile data output by clang should be changed to that extension. - llvm-profdata merges two profiles. However, the name is more general, since it will likely pick up more tasks (such as summarizing a single profile). - llvm-profdata parses the current text-based format, but will be updated once we settle on a binary format. <rdar://problem/15949645> llvm-svn: 201535
* Cleanup docs about lit substitutionsNico Rieck2014-02-151-48/+69
| | | | llvm-svn: 201464
* Fix typoNico Rieck2014-02-151-2/+2
| | | | llvm-svn: 201461
* Add a note about using "Differential Revision:" in commit messagesMark Seaborn2014-02-111-0/+20
| | | | | | | | | | I noticed this convention from the commit logs. It seems like it would be useful to document it, to encourage other committers to link back to code reviews in their commits. Differential Revision: http://llvm-reviews.chandlerc.com/D2678 llvm-svn: 201160
* [docs] [tblgen] clarify that code fragments are just string literalsSean Silva2014-02-091-1/+1
| | | | | | | | Fun fact: looking at the TableGen code (around TGParser.cpp:1166), the only difference in handling is that adjacent regular string literals are concatenated in the parser. llvm-svn: 201035
* [docs] [tblgen] There is no "code" type.Sean Silva2014-02-091-5/+0
| | | | | | Code fragments are just fancy string literals. llvm-svn: 201034
* [docs] TableGen easter egg: Multiline string literalsSean Silva2014-02-091-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | They're called code fragments, but they are really multiline string literals. Just spotted this usage in a patch by Aaron using "code fragments" for holding documentation text. I remember someone bemoaning the lack of multiline string literals in TableGen, so I'm explicitly documenting that code fragments are multiline string literals. Let it be known that any use case needing multiline string literals in TableGen (such as descriptions of options, or whatnot) can use use code fragments (instead of C-style string concatenation or exceedingly long lines). E.g. class Bar<int n>; class Baz<int n>; class Doc<string desc> { string Desc = desc; } def Foo : Bar<1>, Baz<3>, Doc<[{ This Foo is a Bar, and also a Baz. It can take 3 values: * Qux * Quux * Quuux }]>; llvm-svn: 201033
* Remove support for not using .loc directives.Rafael Espindola2014-02-051-0/+4
| | | | | | Clang itself was not using this. The only way to access it was via llc. llvm-svn: 200862
* HowToReleaseLLVM: Add information about dot releasesTom Stellard2014-02-041-6/+15
| | | | | | | Based on the following discussion: http://llvm.1065342.n5.nabble.com/LLVM-3-4-stable-releases-td65005.html llvm-svn: 200772
* Add a note to documentation that Clang + libstdc++ 4.7.2 can not be used to ↵Dmitri Gribenko2014-02-041-0/+5
| | | | | | build LLD. llvm-svn: 200758
* Add a note about Clang+LLVM on Sparc64.Venkatraman Govindaraju2014-02-031-0/+3
| | | | llvm-svn: 200699
OpenPOWER on IntegriCloud