[PATCH] D67777: Improve comments terseness in PassBuilder.h

[Filippo Costa via Phabricator via llvm-commits]

neysofu created this revision.
neysofu added reviewers: chandlerc, asbirlea.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

A small but sensible improvement to some comments. This revision is mostly for me to get the hang of the contributing process to then do bigger tasks.


Repository:
  rL LLVM

https://reviews.llvm.org/D67777

Files:
  include/llvm/Passes/PassBuilder.h


Index: include/llvm/Passes/PassBuilder.h
===================================================================
--- include/llvm/Passes/PassBuilder.h
+++ include/llvm/Passes/PassBuilder.h
@@ -73,30 +73,30 @@
   /// can be set in the PassBuilder when using a LLVM as a library.
   PipelineTuningOptions();
 
-  /// Tuning option to set loop interleaving on/off. Its default value is that
+  /// Enables/disables loop interleaving. Its default value is that
   /// of the flag: `-interleave-loops`.
   bool LoopInterleaving;
 
-  /// Tuning option to enable/disable loop vectorization. Its default value is
+  /// Enables/disables loop vectorization. Its default value is
   /// that of the flag: `-vectorize-loops`.
   bool LoopVectorization;
 
-  /// Tuning option to enable/disable slp loop vectorization. Its default value
+  /// Enables/disables slp loop vectorization. Its default value
   /// is that of the flag: `vectorize-slp`.
   bool SLPVectorization;
 
-  /// Tuning option to enable/disable loop unrolling. Its default value is true.
+  /// Enables/disables loop unrolling. Its default value is true.
   bool LoopUnrolling;
 
-  /// Tuning option to forget all SCEV loops in LoopUnroll. Its default value
+  /// Tells to forget all SCEV loops in LoopUnroll. Its default value
   /// is that of the flag: `-forget-scev-loop-unroll`.
   bool ForgetAllSCEVInLoopUnroll;
 
-  /// Tuning option to cap the number of calls to retrive clobbering accesses in
+  /// Caps the number of calls to retrive clobbering accesses in
   /// MemorySSA, in LICM.
   unsigned LicmMssaOptCap;
 
-  /// Tuning option to disable promotion to scalars in LICM with MemorySSA, if
+  /// Disables promotion to scalars in LICM with MemorySSA, if
   /// the number of access is too large.
   unsigned LicmMssaNoAccForPromotionCap;
 };
@@ -127,9 +127,7 @@
     std::vector<PipelineElement> InnerPipeline;
   };
 
-  /// ThinLTO phase.
-  ///
-  /// This enumerates the LLVM ThinLTO optimization phases.
+  /// Enumerates the possible LLVM ThinLTO optimization phases.
   enum class ThinLTOPhase {
     /// No ThinLTO behavior needed.
     None,
@@ -250,10 +248,10 @@
 
   /// Registers all available CGSCC analysis passes.
   ///
-  /// This is an interface that can be used to populate a \c CGSCCAnalysisManager
-  /// with all registered CGSCC analyses. Callers can still manually register any
-  /// additional analyses. Callers can also pre-register analyses and this will
-  /// not override those.
+  /// This is an interface that can be used to populate a \c
+  /// CGSCCAnalysisManager with all registered CGSCC analyses. Callers can still
+  /// manually register any additional analyses. Callers can also pre-register
+  /// analyses and this will not override those.
   void registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM);
 
   /// Registers all available function analysis passes.
@@ -285,10 +283,8 @@
   /// build them.
   ///
   /// \p Phase indicates the current ThinLTO phase.
-  FunctionPassManager
-  buildFunctionSimplificationPipeline(OptimizationLevel Level,
-                                      ThinLTOPhase Phase,
-                                      bool DebugLogging = false);
+  FunctionPassManager buildFunctionSimplificationPipeline(
+      OptimizationLevel Level, ThinLTOPhase Phase, bool DebugLogging = false);
 
   /// Construct the core LLVM module canonicalization and simplification
   /// pipeline.
@@ -306,8 +302,7 @@
   ///
   /// \p Phase indicates the current ThinLTO phase.
   ModulePassManager
-  buildModuleSimplificationPipeline(OptimizationLevel Level,
-                                    ThinLTOPhase Phase,
+  buildModuleSimplificationPipeline(OptimizationLevel Level, ThinLTOPhase Phase,
                                     bool DebugLogging = false);
 
   /// Construct the core LLVM module optimization pipeline.
@@ -764,6 +759,6 @@
 
   return false;
 }
-}
+} // namespace llvm
 
 #endif


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D67777.220921.patch
Type: text/x-patch
Size: 3927 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190919/aa5a1e28/attachment.bin>