svn: /pear/peardoc/trunk/en/package/php/php-codesniffer/ advanced-usage.xml

squiz                                    Mon, 30 Aug 2010 00:42:43 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=302875

Log:
Made it clearer that you can only limit messages from sniffs that are in the standard you are checking.

Changed paths:
    U   pear/peardoc/trunk/en/package/php/php-codesniffer/advanced-usage.xml

Modified: pear/peardoc/trunk/en/package/php/php-codesniffer/advanced-usage.xml
===================================================================
--- pear/peardoc/trunk/en/package/php/php-codesniffer/advanced-usage.xml	2010-08-29 21:49:27 UTC (rev 302874)
+++ pear/peardoc/trunk/en/package/php/php-codesniffer/advanced-usage.xml	2010-08-30 00:42:43 UTC (rev 302875)
@@ -105,12 +105,17 @@
   <example><info><title>Checking files for two specific sniffs only</title></info>
    <screen>
 <![CDATA[
-$ phpcs --sniffs=Generic.PHP.LowerCaseConstant,PEAR.WhiteSpace.ScopeIndent /path/to/code
+$ phpcs --standard=PEAR --sniffs=Generic.PHP.LowerCaseConstant,PEAR.WhiteSpace.ScopeIndent /path/to/code
 ]]>
    </screen>
   </example>
   <note>
    <simpara>
+    This feature is a message filter and not a quick way to define a custom coding standard. All sniffs specified on the command line in this way must be used in the coding standard you are using to check your files. You can't, for example, limit results to Squiz sniffs while using the PEAR standard as the PEAR standard does not include these sniffs.
+   </simpara>
+  </note>
+  <note>
+   <simpara>
     To view source codes for error messages, use the <literal>-s</literal> command line argument. This will print source codes in the full, summary and source reports.
    </simpara>
   </note>