TASK: Add documentation for new feature

Relates: #41
This commit is contained in:
Daniel Siepmann 2017-04-27 17:05:02 +02:00
parent 4fdc15d715
commit d23bc4d221
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
2 changed files with 29 additions and 4 deletions

View file

@ -165,6 +165,28 @@ Using ``runtime-set``:
--runtime-set removedConstantConfigFiles "/Some/Absolute/Path/*.yaml" --runtime-set removedConstantConfigFiles "/Some/Absolute/Path/*.yaml"
.. _configuration-removedClassConfigFiles:
removedClassConfigFiles
^^^^^^^^^^^^^^^^^^^^^^^^^^
Configure where to look for configuration files defining the removed classes. Default is
``Configuration/Removed/Classes/*.yaml`` inside the standard itself. We already try to deliver as
much as possible. Globing is used, so placeholders like ``*`` are possible, see
https://secure.php.net/manual/en/function.glob.php
Using :file:`ruleset.xml`:
.. code:: xml
<config name="removedClassConfigFiles" value="/Some/Absolute/Path/*.yaml"/>
Using ``runtime-set``:
.. code:: bash
--runtime-set removedClassConfigFiles "/Some/Absolute/Path/*.yaml"
.. _configuration-removedTypoScriptConfigFiles: .. _configuration-removedTypoScriptConfigFiles:
removedTypoScriptConfigFiles removedTypoScriptConfigFiles

View file

@ -96,13 +96,16 @@ Check for removed calls
Also we check for the following deprecated calls: Also we check for the following deprecated calls:
Check for usage of *removed functions* in general. The functions are configured via yaml files. The Check for usage of *removed PHP functions* in general. The functions are configured via yaml files.
location of them is configurable, default is inside the standard itself, and we try to deliver all The location of them is configurable, default is inside the standard itself, and we try to deliver
information. For configuration options see :ref:`configuration-removedFunctionConfigFiles`. all information. For configuration options see :ref:`configuration-removedFunctionConfigFiles`.
Check for usage of *removed constants*. The constants are configured in same way as removed Check for usage of *removed PHP constants*. The constants are configured in same way as removed
functions. For configuration options see :ref:`configuration-removedConstantConfigFiles`. functions. For configuration options see :ref:`configuration-removedConstantConfigFiles`.
Check for usage of *removed PHP classes*. The classes are configured in same way as removed
functions. For configuration options see :ref:`configuration-removedClassConfigFiles`.
Further checks Further checks
-------------- --------------