[Docs] Improve cycle and closed path definitions
authorJannik Silvanus <jannik.silvanus@amd.com>
Mon, 1 Aug 2022 09:46:02 +0000 (11:46 +0200)
committerJannik Silvanus <jannik.silvanus@amd.com>
Wed, 3 Aug 2022 08:28:13 +0000 (10:28 +0200)
commitd0bfebda5b789621dd97b5dca0bd2082a82e82d9
tree4456e133db8bb80b98b5950d72f4a4ec7331b714
parent3285f94244ecda0912c76c9b1e9b16e0cf96d073
[Docs] Improve cycle and closed path definitions

Improve the cycle definition, by avoiding usage of not yet defined
or only vaguely defined terminology inside definitions.
More precisely, the existing definition defined "outermost cycles",
and then proceeded to use the term "cycles" for further definitions,
which in turn were used to actually define "cycles".

Now, instead only define "cycles". This does not change the meaning
of a cycle, which depends on the chosen surrounding (subgraph) of a CFG.

Also mention the function CFG in the first definition, because later
later definitions require it anyways.

Also slightly improve the definition of a closed path, by explicitly
requiring the inner nodes to be distinct.

Differential Revision: https://reviews.llvm.org/D130891
llvm/docs/CycleTerminology.rst
llvm/include/llvm/ADT/GenericCycleInfo.h