cvs: peardoc /en/package/php/php-codesniffer config-options.xml

squiz		Wed Nov  7 05:50:29 2007 UTC

  Modified files:              
    /peardoc/en/package/php/php-codesniffer	config-options.xml 
  Log:
  Added docs for hiding warnings by default
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-codesniffer/config-options.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/php/php-codesniffer/config-options.xml
diff -u peardoc/en/package/php/php-codesniffer/config-options.xml:1.1 peardoc/en/package/php/php-codesniffer/config-options.xml:1.2
--- peardoc/en/package/php/php-codesniffer/config-options.xml:1.1	Wed Sep 19 04:40:32 2007
+++ peardoc/en/package/php/php-codesniffer/config-options.xml	Wed Nov  7 05:50:28 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="ISO-8859-1" ?>
-<!-- $Revision: 1.1 $ --> 
+<!-- $Revision: 1.2 $ --> 
 <refentry id="package.php.php-codesniffer.config-options">
  <refnamediv>
   <refname>Configuration Options</refname>
@@ -26,6 +26,28 @@
    </example>
   </refsect2>
 
+  <refsect2 id="package.php.php-codesniffer.config-options.php-codesniffer.show-warnings">
+   <title>Hiding Warnings by Default</title>
+   <para>
+    By default, PHP_CodeSniffer will show both errors and warnings for your code. You can hide warnings for a single script run by using the <literal>-n</literal> command line argument, but you can also enable this by default if you prefer. To hide warnings by default, set the <literal>show_warnings</literal> configuration option to <literal>0</literal>.
+   </para>
+   <example>
+    <title>Hiding warnings by default</title>
+    <screen>
+     <userinput>
+<![CDATA[
+$ phpcs --config-set show_warnings 0
+]]>
+     </userinput>
+    </screen>
+   </example>
+   <note>
+    <simpara>
+     When warnings are hidden by default, you can use the <literal>-w</literal> command line argument to show them for a single script run.
+    </simpara>
+   </note>
+  </refsect2>
+
  </refsect1>