[PATCH] D31758: Invariant.group and mustalias docs fixes

[Sanjoy Das via Phabricator via llvm-commits]

sanjoy requested changes to this revision.
sanjoy added a comment.
This revision now requires changes to proceed.

Minor comments inline.



================
Comment at: docs/AliasAnalysis.rst:139
 guaranteed to always start at exactly the same location. A ``MustAlias``
-response implies that the pointers compare equal.
+response not implies that the pointers compare equal.
 
----------------
A better wording would be "A ``MustAlias`` response does not imply that the pointers compare equal."


================
Comment at: docs/LangRef.rst:5121
 
+Because `invariant.group` is tied to the SSA value of the pointer operand,
+replacing one pointer by another based on `mustalias` returned from Alias
----------------
This is minor, but I'd s/Because/Since/

Even better, I'd put the (IMO more important) warning before its justification:

The `invariant.group` metadata must be dropped when replacing one pointer by another based on aliasing information.  This is because `invariant.group` is tied to the SSA value of the pointer operand.


================
Comment at: docs/LangRef.rst:5129
+
+Where replacing by SSA values equivalence is not required to discard
+`invariant.group` metadata.
----------------
Not sure what this line adds -- can you give an example here as well?


https://reviews.llvm.org/D31758