[clang-tools-extra] r183981 - cpp11-migrate: Fixing section markup
Edwin Vane
edwin.vane at intel.com
Fri Jun 14 08:14:20 PDT 2013
Author: revane
Date: Fri Jun 14 10:14:20 2013
New Revision: 183981
URL: http://llvm.org/viewvc/llvm-project?rev=183981&view=rev
Log:
cpp11-migrate: Fixing section markup
Adhering to LLVM's ReST style for section markup.
Modified:
clang-tools-extra/trunk/docs/AddOverrideTransform.rst
clang-tools-extra/trunk/docs/LoopConvertTransform.rst
clang-tools-extra/trunk/docs/MigratorUsage.rst
clang-tools-extra/trunk/docs/UseAutoTransform.rst
clang-tools-extra/trunk/docs/cpp11-migrate.rst
Modified: clang-tools-extra/trunk/docs/AddOverrideTransform.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/AddOverrideTransform.rst?rev=183981&r1=183980&r2=183981&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/AddOverrideTransform.rst (original)
+++ clang-tools-extra/trunk/docs/AddOverrideTransform.rst Fri Jun 14 10:14:20 2013
@@ -26,7 +26,7 @@ For example:
};
Using Expands-to-Override Macros
---------------------------------
+================================
Like LLVM's ``LLVM_OVERRIDE``, several projects have macros that conditionally
expand to the ``override`` keyword when compiling with C++11 features enabled.
@@ -37,7 +37,7 @@ Migrator to enable this behavior.
Known Limitations
------------------
+=================
* This transform will not insert the override keyword if a method is
pure. At the moment it's not possible to track down the pure
specifier location.
Modified: clang-tools-extra/trunk/docs/LoopConvertTransform.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/LoopConvertTransform.rst?rev=183981&r1=183980&r2=183981&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/LoopConvertTransform.rst (original)
+++ clang-tools-extra/trunk/docs/LoopConvertTransform.rst Fri Jun 14 10:14:20 2013
@@ -18,7 +18,7 @@ Risk
====
Risky
-^^^^^
+-----
In loops where the container expression is more complex than just a
reference to a declared expression (a variable, function, enum, etc.),
@@ -44,7 +44,7 @@ for an example of an incorrect transform
level is set to `risky`.
Reasonable (Default)
-^^^^^^^^^^^^^^^^^^^^
+--------------------
If a loop calls ``.end()`` or ``.size()`` after each iteration, the
transformation for that loop is marked as `reasonable`, and thus will
@@ -58,7 +58,7 @@ be converted if the acceptable risk leve
cout << container[i];
Safe
-^^^^
+----
Any other loops that do not match the above criteria to be marked as
`risky` or `reasonable` are marked `safe`, and thus will be converted
@@ -129,7 +129,7 @@ should be aware of the behaviour and lim
the cases below.
Comments inside loop headers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----------------------------
Comments inside the original loop header are ignored and deleted when
transformed.
@@ -139,7 +139,7 @@ transformed.
for (int i = 0; i < N; /* This will be deleted */ ++i) { }
Range-based loops evaluate end() only once
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+------------------------------------------
The C++11 range-based for loop calls ``.end()`` only once during the
initialization of the loop. If in the original loop ``.end()`` is called after
@@ -205,7 +205,7 @@ transformed loop if ``.end()`` was origi
}
Overloaded operator->() with side effects
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------------------
Similarly, if ``operator->()`` was overloaded to have side effects, such as
logging, the semantics will change. If the iterator's ``operator->()`` was used
@@ -225,7 +225,7 @@ performed.
}
Pointers and references to containers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------------------
While most of the transform's risk analysis is dedicated to determining whether
the iterator or container was modified within the loop, it is possible to
Modified: clang-tools-extra/trunk/docs/MigratorUsage.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/MigratorUsage.rst?rev=183981&r1=183980&r2=183981&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/MigratorUsage.rst (original)
+++ clang-tools-extra/trunk/docs/MigratorUsage.rst Fri Jun 14 10:14:20 2013
@@ -10,7 +10,7 @@ relative to the current directory.
At least one transform must be enabled.
General Command Line Options
-----------------------------
+============================
.. option:: -help
@@ -88,7 +88,7 @@ General Command Line Options
replacements.
Transform-Specific Command Line Options
----------------------------------------
+=======================================
.. option:: -loop-convert
Modified: clang-tools-extra/trunk/docs/UseAutoTransform.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/UseAutoTransform.rst?rev=183981&r1=183980&r2=183981&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/UseAutoTransform.rst (original)
+++ clang-tools-extra/trunk/docs/UseAutoTransform.rst Fri Jun 14 10:14:20 2013
@@ -131,7 +131,7 @@ following conditions are satisfied:
deduced as``std::initializer_list``.
Known Limitations
------------------
+=================
* If the initializer is an explicit conversion constructor, the transform will
not replace the type specifier even though it would be safe to do so.
* User-defined iterators are not handled at this time.
Modified: clang-tools-extra/trunk/docs/cpp11-migrate.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/cpp11-migrate.rst?rev=183981&r1=183980&r2=183981&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/cpp11-migrate.rst (original)
+++ clang-tools-extra/trunk/docs/cpp11-migrate.rst Fri Jun 14 10:14:20 2013
@@ -18,7 +18,7 @@ C++98 and C++03 code to use features of
appropriate.
Getting Started
----------------
+===============
To build from source:
@@ -70,7 +70,7 @@ unless ``-final-syntax-check`` is enable
.. _Clang Tools Documentation: http://clang.llvm.org/docs/ClangTools.html
Getting Involved
-----------------
+================
If you find a bug
@@ -101,7 +101,7 @@ be completed.
.. _transforms:
Transformations
----------------
+===============
The Migrator is a collection of independent transforms which can be
independently enabled. The transforms currently implemented are:
More information about the cfe-commits
mailing list