[PATCH] D74989: [LoopTerminology] Loop Simplify Form

[Michael Kruse via Phabricator via llvm-commits]

Meinersbur added inline comments.


================
Comment at: llvm/docs/LoopTerminology.rst:152
+a LoopPass. This pass is implemented in
+`LoopInfo.h http://llvm.org/doxygen/LoopSimplify_8h_source.html`_.
+When it is successful, the loop has:
----------------
baziotis wrote:
> Meinersbur wrote:
> > baziotis wrote:
> > > This is an external link. I don't know if this is ok.
> > It's a link to the doxygen-generated reference, not the link that @fhahn suggested. (I don't mind keeping the doxygen link)
> > 
> > Documentation for cross-references (preferable within Sphinx) is [[ https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role | here ]].
> > 
> I didn't get it, thanks. From what I read, @fhahn probably meant using `:ref:`. I think that because the `-loop-simplify` doc doesn't have a link to the file that implements it, it's better to link the doxygen file. Since I think, if someone reads the `-loop-simplify` doc without seeing the `.h`, they won't understand much (i.e. better just read the more abstract one in `LoopTerminology.rst`). What do you think?
Nothing stops us from linking to both documents. It is just nice to the reader to cross-ref other relevant documents such as https://llvm.org/docs/Passes.html#loop-simplify-canonicalize-natural-loops

The other way around Passes.rst could also cross-link back to here.


================
Comment at: llvm/docs/LoopTerminology.rst:149
+several analyses and transformations simpler and more effective.
+This loop is ensured by the LoopSimplify (`-loop-simplify`) pass
+and is automatically added by the pass managers when scheduling
----------------
"This loop is ensures ...": The canonical form is ensured, the loop is already there before LoopSimplify.


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D74989/new/

https://reviews.llvm.org/D74989