TASK: Document configuration option

Relates: #7
This commit is contained in:
Daniel Siepmann 2017-03-16 11:06:15 +01:00
parent cdccab83bc
commit cc9552e028
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4

View file

@ -82,3 +82,23 @@ What does it look like?
----------------------------------------------------------------------
Time: 35ms; Memory: 5Mb
Configuration
=============
Configuration is done through PHPCS Standards, e.g. provide a custom ``ruleset.xml`` or customize
the provided one.
``legacyExtensions``
Configures which extension names are legacy. Used to provide further checks and warnings about
possible legacy code. E.g. inside of non auto migrated situations.
Example:
.. code:: xml
<rule ref="Typo3Update.LegacyClassnames.Instanceof">
<properties>
<property name="legacyExtensions" type="array" value="Extbase,Fluid,Frontend,Core"/>
</properties>
</rule>