[PATCH] D24436: Fix misleading comment for getOrEnforceKnownAlignment

[Justin Lebar via llvm-commits]

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

I'm happy with the edits below.

Thanks for fixing this.


================
Comment at: include/llvm/Transforms/Utils/Local.h:166
@@ +165,3 @@
+/// the owning object can be modified and has an alignment less than \p
+/// PrefAlign, it will be increased. If the alignment cannot be increased, the
+/// known alignment of the value is returned. It is not always possible to
----------------
I still can't tell what this function returns on "success".  Perhaps s/increased/increased and PrefAlign returned/?

================
Comment at: include/llvm/Transforms/Utils/Local.h:167
@@ +166,3 @@
+/// PrefAlign, it will be increased. If the alignment cannot be increased, the
+/// known alignment of the value is returned. It is not always possible to
+/// modify the alignment of the underlying object, so if alignment is important,
----------------
New paragraph before "It"?


https://reviews.llvm.org/D24436