summaryrefslogtreecommitdiffstats
path: root/llvm/docs/GarbageCollection.rst
Commit message (Collapse)AuthorAgeFilesLines
* [GC docs] Update the gcroot documentation to reflect recent simplifcations ↵Philip Reames2018-11-121-90/+20
| | | | | | to GCStrategy configurability llvm-svn: 346702
* Remove @brief commands from doxygen comments, too.Adrian Prantl2018-05-011-4/+4
| | | | | | | | | | | | | | | | | This is a follow-up to r331272. We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done https://reviews.llvm.org/D46290 llvm-svn: 331275
* Update method names in documentation.Rafael Espindola2018-04-061-5/+5
| | | | | | They were renamed in r328848. llvm-svn: 329368
* Tidy up example of getting the pointer size.Eric Christopher2016-10-141-1/+1
| | | | llvm-svn: 284201
* [docs] Fixing Sphinx warnings to unclog the buildbotRenato Golin2016-07-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | Lots of blocks had "llvm" or "nasm" syntax types but either weren't following the syntax, or the syntax has changed (and sphinx hasn't keep up) or the type doesn't even exist (nasm?). Other documents had :options: what were invalid. I only removed those that had warnings, and left the ones that didn't, in order to follow the principle of least surprise. This is like this for ages, but the buildbot is now failing on errors. It may take a while to upgrade the buildbot's sphinx, if that's even possible, but that shouldn't stop us from getting docs updates (which seem down for quite a while). Also, we're not losing any syntax highlight, since when it doesn't parse, it doesn't colour. Ie. those blocks are not being highlighted anyway. I'm trying to get all docs in one go, so that it's easy to revert later if we do fix, or at least easy to know what's to fix. llvm-svn: 276109
* Document the CoreCLR GC StrategySwaroop Sridhar2015-05-211-0/+23
| | | | | | | Add notead about the CoreCLR GC Strategy to the Garbage Collection document. llvm-svn: 237869
* [GC Docs] Update LangRef to link to Statepoint docsPhilip Reames2015-02-251-0/+2
| | | | | | | | Add a brief section linking to the experimental statepoint intrinsics analogous to the one we have linking to patchpoint. While I'm here, cleanup some wording about what the gc "name" attribute actually means. It's not the name of a *collector* it's the name of the *strategy* which may be compatible with multiple collectors. llvm-svn: 230576
* [GC docs] Fill in description of the statepoint-example GC strategyPhilip Reames2015-02-251-3/+15
| | | | llvm-svn: 230572
* [GC Docs] Minor wording clarificationPhilip Reames2015-02-251-3/+3
| | | | llvm-svn: 230570
* Fix consistently wrong sphinx markupPhilip Reames2015-02-251-6/+6
| | | | | | I'd been using '' where I should have been using ``. llvm-svn: 230407
* Update the GC docs to explicitly mention both gcroot and gc.statepointPhilip Reames2015-02-251-10/+29
| | | | | | Also, fix confusing bit of the gcroot documentation that bit me personally. llvm-svn: 230405
* More GC documentation cleanupPhilip Reames2015-02-241-21/+24
| | | | llvm-svn: 230402
* More GC doc cleanupPhilip Reames2015-02-241-41/+51
| | | | | | Mostly minor wording changes for readability. Nothing major to see here. llvm-svn: 230397
* Improve the getting started instructions in the GC docsPhilip Reames2015-02-241-123/+142
| | | | | | This is still gcroot vs gc.statepoint agnostic. I'm just trying to clarify the general documentation at this point. llvm-svn: 230393
* Starting to cleanup the garbage collection documentationPhilip Reames2015-02-241-125/+172
| | | | | | | | | | | | In this change: - Put the getting started section first - Create a dedicated section to document the built in collector strategies - Move discuss of ShadowStack into new section - Add placeholders for erlang, ocaml, and statepoint-example collectors There will be many more changes following. I plan on full integrating the documentation for gc.statepoint and gc.root. I want to make it much clearer on how to get started and what users should expect in terms of effort. llvm-svn: 230359
* Remove gc.root's performCustomLoweringPhilip Reames2015-01-281-63/+12
| | | | | | | | | | | | | | This is a refactoring to restructure the single user of performCustomLowering as a specific lowering pass and remove the custom lowering hook entirely. Before this change, the LowerIntrinsics pass (note to self: rename!) was essentially acting as a pass manager, but without being structured in terms of passes. Instead, it proxied calls to a set of GCStrategies internally. This adds a lot of conceptual complexity (i.e. GCStrategies are stateful!) for very little benefit. Since there's been interest in keeping the ShadowStackGC working, I extracting it's custom lowering pass into a dedicated pass and just added that to the pass order. It will only run for functions which opt-in to that gc. I wasn't able to find an easy way to preserve the runtime registration of custom lowering functionality. Given that no user of this exists that I'm aware of, I made the choice to just remove that. If someone really cares, we can look at restoring it via dynamic pass registration in the future. Note that despite the large diff, none of the lowering code actual changes. I added the framing needed to make it a pass and rename the class, but that's it. Differential Revision: http://reviews.llvm.org/D7218 llvm-svn: 227351
* Remove the TargetMachine forwards for TargetSubtargetInfo basedEric Christopher2014-08-041-1/+1
| | | | | | information and update all callers. No functional change. llvm-svn: 214781
* Fix 'platform-specific' hyphenationsAlp Toker2014-06-301-1/+1
| | | | llvm-svn: 212056
* 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
* Remove reference to obsolete arguments.Bill Wendling2013-10-181-4/+4
| | | | llvm-svn: 193009
* Update to reflect current GC APIs and usage. The example code is taken from ↵Bill Wendling2013-10-181-62/+48
| | | | | | the Erlang GC implementation. llvm-svn: 193008
* IR headers moved to llvm/IR some aeons ago, update documentation.Benjamin Kramer2013-07-081-5/+5
| | | | llvm-svn: 185854
* remove the rest of the "written by" lines in the documentation. It isChris Lattner2013-01-101-3/+0
| | | | | | | against the developer policy to include this sort of thing as SVN blame already captures this in a far more fine-grained way. llvm-svn: 172109
* Documentation: convert WritingAnLLVMPass.html to reST.Dmitri Gribenko2012-12-121-3/+3
| | | | | | Patch by Anthony Mykhailenko with small fixes by me. llvm-svn: 169992
* Documentation: cleanup: remove useless anchors and write :ref:s explicitly.Dmitri Gribenko2012-12-111-27/+8
| | | | llvm-svn: 169932
* docs: Convert GarbageCollection.html to reSTSean Silva2012-12-091-0/+1051
Patch by Alexander Zinenko! llvm-svn: 169702
OpenPOWER on IntegriCloud