]> granicus.if.org Git - llvm/commit
Define some basic terminology around loops in our documentation
authorPhilip Reames <listmail@philipreames.com>
Wed, 24 Jul 2019 23:24:13 +0000 (23:24 +0000)
committerPhilip Reames <listmail@philipreames.com>
Wed, 24 Jul 2019 23:24:13 +0000 (23:24 +0000)
commit30a4a88cc4a2df997f755568bf94c7ef3f2e2959
tree4f6c32a52e95051d6014b61ecaf587c8f7f5b9bf
parent9db59cfdbd23abe5fed3e047437468e6478392b2
Define some basic terminology around loops in our documentation

I've noticed a lot of confusion around this area recently with key terms being misused in a number of threads. To help reign that in, let's go ahead and document the current terminology and meaning thereof.

My hope is to grow this over time into a broader discussion of canonical loop forms - yes, there are more than one ... many more than one - but for the moment, simply having the key terminology is a good stopping place.

Note: I am landing this *without* an LGTM.  All feedback so far has been positive, and trying to apply all of the suggested changes/extensions would cause the review to never end.  Instead, I decided to land it with the obvious fixes made based on reviewer comments, then iterate from there.

Differential Revision: https://reviews.llvm.org/D65164

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@366960 91177308-0d34-0410-b5e6-96231b3b80d8
docs/LoopTerminology.rst [new file with mode: 0644]
include/llvm/Analysis/LoopInfo.h