maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/clang-tools-extra/docs/cpp11-migrate.rst

118 lines
3.3 KiB
ReStructuredText
Raw Normal View History

Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
.. index:: cpp11-migrate
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
===========================
cpp11-migrate User's Manual
===========================
Adding user documentation for UseAuto transform Reviewers: silvas, gribozavr llvm-svn: 176735
2013-03-09 07:26:00 +08:00
.. toctree::
:hidden:
UseAutoTransform
Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
UseNullptrTransform
LoopConvertTransform
Adding the AddOverride transform for cpp11-migrate This transform adds the override specifier to methods that overrides virtual methods from a base class that don't already have this specifier. Author: Philip Dunstan <phil@phildunstan.com> llvm-svn: 179127
2013-04-10 04:49:49 +08:00
AddOverrideTransform
Adding user documentation for UseAuto transform Reviewers: silvas, gribozavr llvm-svn: 176735
2013-03-09 07:26:00 +08:00
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
:program:`cpp11-migrate` is a standalone tool used to automatically convert
C++98 and C++03 code to use features of the new C++11 standard where
appropriate.
Basic Usage
===========
``cpp11-migrate [options] <source0> [... <sourceN>]``
``<source0>...`` specify the paths of files in the CMake source tree,
with the same requirements as other tools built on LibTooling.
Command Line Options
--------------------
.. option:: -help
Displays tool usage instructions and command line options.
.. option:: -loop-convert
Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
Makes use of C++11 range-based for loops where possible. See
:doc:`LoopConvertTransform`.
.. option:: -use-nullptr
Makes use of the new C++11 keyword ``nullptr`` where possible.
See :doc:`UseNullptrTransform`.
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
Allow users to specify NULL like macros to be replaced -use-nullptr only replaced macro named NULL and ignored any user defined macros that behaved like NULL. This patch introduces -user-null-macros command line option to let users specify their custom NULL like macros. - Added a -user-null-macros command line option that takes a comma-separated list of user-defined macros to be replaced when using the -use-nullptr transform. - Added documentation. - Updated testcase to reflect current behavior. - Whitespace fixes. Reviewers: revane, klimek, gribozavr llvm-svn: 178243
2013-03-29 00:06:59 +08:00
.. option:: -user-null-macros=<string>
``<string>`` is a comma-separated list of user-defined macros that behave like
the ``NULL`` macro. The :option:`-use-nullptr` transform will replace these
macros along with ``NULL``. See :doc:`UseNullptrTransform`.
Adding user documentation for UseAuto transform Reviewers: silvas, gribozavr llvm-svn: 176735
2013-03-09 07:26:00 +08:00
.. option:: -use-auto
Replace the type specifier of variable declarations with the ``auto`` type
specifier. See :doc:`UseAutoTransform`.
Adding the AddOverride transform for cpp11-migrate This transform adds the override specifier to methods that overrides virtual methods from a base class that don't already have this specifier. Author: Philip Dunstan <phil@phildunstan.com> llvm-svn: 179127
2013-04-10 04:49:49 +08:00
.. option:: -add-override
Adds the override specifier to member functions where it is appropriate. That
is, the override specifier is added to member functions that override a
virtual function in a base class and that don't already have the specifier.
See :doc:`AddOverrideTransform`.
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
.. option:: -p=<build-path>
``<build-path>`` is a CMake build directory containing a file named
``compile_commands.json`` which provides compiler options for building
each source file and can be generated by specifying
``-DCMAKE_EXPORT_COMPILE_COMMANDS`` when running CMake. If ``<build-path>``
is not provided the ``compile_commands.json`` file is searched for through
all parent directories.
Alternatively, one can provide compile options to be applied to every
source file after the optional ``--``.
.. option:: -risk=<risk-level>
Some transformations may cause a change in semantics. In such cases the
maximum acceptable risk level specified through the ``-risk`` command
line option decides whether or not a transformation is applied.
Three different risk level options are available:
``-risk=safe``
Perform only safe transformations.
``-risk=reasonable`` (default)
Enable transformations that may change semantics.
``-risk=risky``
Enable transformations that are likely to change semantics.
Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
The meaning of risk is handled differently for each transform. See
:ref:`transform documentation <transforms>` for details.
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
Adding -final-syntax-check to cpp11-migrate user docs llvm-svn: 176758
2013-03-09 11:38:20 +08:00
.. option:: -final-syntax-check
Allow users to specify NULL like macros to be replaced -use-nullptr only replaced macro named NULL and ignored any user defined macros that behaved like NULL. This patch introduces -user-null-macros command line option to let users specify their custom NULL like macros. - Added a -user-null-macros command line option that takes a comma-separated list of user-defined macros to be replaced when using the -use-nullptr transform. - Added documentation. - Updated testcase to reflect current behavior. - Whitespace fixes. Reviewers: revane, klimek, gribozavr llvm-svn: 178243
2013-03-29 00:06:59 +08:00
Adding -final-syntax-check to cpp11-migrate user docs llvm-svn: 176758
2013-03-09 11:38:20 +08:00
After applying the final transform to a file, parse the file to ensure the
last transform did not introduce syntax errors. Syntax errors introduced by
earlier transforms are already caught when subsequent transforms parse the
file.
.. option:: -fatal-assembler-warnings
Treat all compiler warnings as errors.
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
.. option:: -version
Displays the version information of this tool.
Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
.. _transforms:
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
Transformations
===============
Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
* :doc:`LoopConvertTransform`
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
* :doc:`UseNullptrTransform`
Add user documentation for cpp11-migrate Adding an RST document for cpp11-migrate. This user documentation explains command line options, transformations, risk level and how it applies to loop convert, and code examples of transformations. There is a TODO task under "Risk" for "Loop Convert" to find code examples that produce incorrect transformations that change semantics. The definition of risk in loop convert and instances where the confidence level is lowered will need to be looked at more carefully. Information for all new features (including verbose output, auto transform) will be added in a later change. Author: Jack Yang <jack.wang@intel.com> Reviewer: grigozavr llvm-svn: 176046
2013-02-26 04:37:03 +08:00
Splitting cpp11-migrate transform docs into sub-pages Each transform belongs in its own sub-page now. Minor refactoring to reflect new heading levels. llvm-svn: 176757
2013-03-09 11:33:50 +08:00
* :doc:`UseAutoTransform`