From 4a7ffaa92dda0a08df811c90a1f671887072ca2c Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Tue, 4 Apr 2017 10:59:46 +0200 Subject: [PATCH] TASK: Update documentation * Add new feature to docs. Resolves: #42 --- Readme.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/Readme.rst b/Readme.rst index e87a3a8..e1b5cb4 100644 --- a/Readme.rst +++ b/Readme.rst @@ -108,6 +108,10 @@ available to generate a report of possible issues and during coding through ``ph inside the standard itself, and we try to deliver all information. For configuration options see ``removedFunctionConfigFiles``. +- Check for usage of removed constants. + The constants are configured in same way as removed functions. + For configuration options see ``removedConstantsConfigFiles``. + What does it look like? ======================= @@ -220,3 +224,21 @@ Example: .. code:: bash --runtime-set removedFunctionConfigFiles "/Some/Absolute/Path/*.yaml" + +``removedConstantConfigFiles`` + Configure your vendor through ``ruleset.xml`` or using ``--runtime-set``. Default is + ``Configuration/Removed/Constants/*.yaml`` inside the standard itself. + Globing is used, so placeholders like ``*`` are possible, see + https://secure.php.net/manual/en/function.glob.php + + Example: + +.. code:: xml + + + +Example: + +.. code:: bash + + --runtime-set removedConstantConfigFiles "/Some/Absolute/Path/*.yaml"