summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakub Kuderski <kubakuderski@gmail.com>2018-07-28 00:54:07 +0000
committerJakub Kuderski <kubakuderski@gmail.com>2018-07-28 00:54:07 +0000
commit81db59b6f120a5a0f253fa64fc9f7175314ae29b (patch)
treed4af22dc88e5ac80b20124a8f48ebce5244fb82e
parent32fa8715475f2ecff33a0bd5fb92d8aabbf40640 (diff)
downloadbcm5719-llvm-81db59b6f120a5a0f253fa64fc9f7175314ae29b.tar.gz
bcm5719-llvm-81db59b6f120a5a0f253fa64fc9f7175314ae29b.zip
[Dominators] Make applyUpdate's documentation less confusing [NFC]
Summary: It was pointed out by @chandlerc that it's not clear whether both applyUpdates and insert/deleteEdge can be used to perform multiple updates. IMO, the confusing part was that the comment above applyUpdates made a comparison of expected update time between calling it and calling insert/deleteEdge multiple times. It's generally not possible to safely call insert/deleteEdge multiple times, which documentation for each of the 3 functions warns about, so the whole comparison makes very little sense. On top of that, the comment is already lengthy, so I think it's best to just get rid of this comparison. Reviewers: chandlerc, asbirlea, NutshellySima, grosser Reviewed By: chandlerc Subscribers: llvm-commits, chandlerc Differential Revision: https://reviews.llvm.org/D49944 llvm-svn: 338184
-rw-r--r--llvm/include/llvm/Support/GenericDomTree.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/llvm/include/llvm/Support/GenericDomTree.h b/llvm/include/llvm/Support/GenericDomTree.h
index 115abc23e2c..e93d570c271 100644
--- a/llvm/include/llvm/Support/GenericDomTree.h
+++ b/llvm/include/llvm/Support/GenericDomTree.h
@@ -530,11 +530,10 @@ protected:
/// CFG about its children and inverse children. This implies that deletions
/// of CFG edges must not delete the CFG nodes before calling this function.
///
- /// Batch updates should be generally faster when performing longer sequences
- /// of updates than calling insertEdge/deleteEdge manually multiple times, as
- /// it can reorder the updates and remove redundant ones internally.
- /// The batch updater is also able to detect sequences of zero and exactly one
- /// update -- it's optimized to do less work in these cases.
+ /// The applyUpdates function can reorder the updates and remove redundant
+ /// ones internally. The batch updater is also able to detect sequences of
+ /// zero and exactly one update -- it's optimized to do less work in these
+ /// cases.
///
/// Note that for postdominators it automatically takes care of applying
/// updates on reverse edges internally (so there's no need to swap the
OpenPOWER on IntegriCloud