[PATCH] Add limitations to loop convert user doc

Edwin Vane edwin.vane at intel.com
Fri Mar 22 12:41:54 PDT 2013



================
Comment at: docs/LoopConvertTransform.rst:131
@@ +130,3 @@
+
+Comments inside loop headers are not preserved
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------
The subheaders under "limitations", for consistency, should all talk about the same kind of thing. Looking at all the headers it looks like you want the headers to talk about "causes of problems". In that case, this header should be "Comments inside loop headers".

================
Comment at: docs/LoopConvertTransform.rst:141
@@ +140,3 @@
+
+Range-based loops evaluates end() only once
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------
evaluates->evaluate.

================
Comment at: docs/LoopConvertTransform.rst:228
@@ +227,3 @@
+
+Pointers and references circumvent risk analysis
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
----------------
Following the scheme of headers talking about problem causes this should be "Pointers and references to containers"

================
Comment at: docs/LoopConvertTransform.rst:42
@@ +41,3 @@
+See
+:ref:`Range-based loops evaluates end() only once<IncorrectRiskyTransformation>`
+for an example of an incorrect transformation when the maximum acceptable risk
----------------
For ease of documentation maintenance you might consider a specially named anchor that's shorter than what you've got here.


http://llvm-reviews.chandlerc.com/D552



More information about the cfe-commits mailing list