[PATCH] D27367: [PM] Edit comments in PassManager.h.

Chandler Carruth via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Jan 2 20:18:49 PST 2017


chandlerc accepted this revision.
chandlerc added a comment.
This revision is now accepted and ready to land.

Minor comments below, this patch LGTM with fixes to them.

I'd appreciate doing precommit review on these patches if there is any semantic changes mostly to check and make sure you're not spotting a bug where the old comment should have been correct but wasn't due to bugs or mistakes in the code.

I'm not worried about merge conflicts. The biggest patch i've got in-progress is mostly touching LoopPassManager stuff.



================
Comment at: llvm/include/llvm/IR/PassManager.h:133-134
 
-  /// \brief Query whether an abstract pass ID is marked as preserved by this
-  /// set.
+  /// \brief Given a pointer to its AnalysisKey, query whether a pass is marked
+  /// as preserved by this set.
   bool preserved(AnalysisKey *ID) const {
----------------
Above you use "Given an analysis's ID", here you use "Given a pointer to its AnalysisKey". I mildly prefer the former wording to the latter, but I'm more interested in consistency.


================
Comment at: llvm/include/llvm/IR/PassManager.h:448-449
   ///
-  /// A flag can be passed to indicate that the manager should perform debug
-  /// logging.
+  /// If DebugLogging is true, the manager will log its progress to
+  /// \c llvm::dbgs().
   AnalysisManager(bool DebugLogging = false) : DebugLogging(DebugLogging) {}
----------------
Make the DebugLogging comments consistent? And use `\p DebugLogging`?


https://reviews.llvm.org/D27367





More information about the llvm-commits mailing list