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

squiz		Wed Nov 28 22:59:33 2007 UTC

  Modified files:              
    /peardoc/en/package/php/php-codesniffer	config-options.xml 
  Log:
  Added docs for new report_format config option
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-codesniffer/config-options.xml?r1=1.3&r2=1.4&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.3 peardoc/en/package/php/php-codesniffer/config-options.xml:1.4
--- peardoc/en/package/php/php-codesniffer/config-options.xml:1.3	Mon Nov 26 23:49:04 2007
+++ peardoc/en/package/php/php-codesniffer/config-options.xml	Wed Nov 28 22:59:33 2007
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="ISO-8859-1" ?>
-<!-- $Revision: 1.3 $ --> 
+<!-- $Revision: 1.4 $ --> 
 <refentry id="package.php.php-codesniffer.config-options">
  <refnamediv>
   <refname>Configuration Options</refname>
@@ -26,6 +26,23 @@
    </example>
   </refsect2>
 
+  <refsect2 id="package.php.php-codesniffer.config-options.php-codesniffer.report-format">
+   <title>Setting the Default Report Format</title>
+   <para>
+    By default, PHP_CodeSniffer will use the <emphasis>full</emphasis> report format if no format is supplied on the command line. You can change the default report format by setting the <literal>report_format</literal> configuration option.
+   </para>
+   <example>
+    <title>Setting the default report format to be the summary report</title>
+    <screen>
+     <userinput>
+<![CDATA[
+$ phpcs --config-set report_format summary
+]]>
+     </userinput>
+    </screen>
+   </example>
+  </refsect2>
+
   <refsect2 id="package.php.php-codesniffer.config-options.php-codesniffer.show-warnings">
    <title>Hiding Warnings by Default</title>
    <para>