cvs: peardoc /en/package/php php-codesniffer.xml /en/package/php/php-codesniffer reporting.xml requirements.xml svn-pre-commit.xml

squiz		Mon Jun 29 03:48:40 2009 UTC

  Added files:                 
    /peardoc/en/package/php/php-codesniffer	requirements.xml 

  Modified files:              
    /peardoc/en/package/php	php-codesniffer.xml 
    /peardoc/en/package/php/php-codesniffer	reporting.xml 
                                           	svn-pre-commit.xml 
  Log:
  Added a new Requirements page showing how the pre-commit hook has different requirements than PHPCS. ALso updated the pre-commit hook page to show the same message. Added a link to the reporting page, which was ommitted by mistake when the reproting docs were added some time ago.
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-codesniffer.xml?r1=1.9&r2=1.10&diff_format=u
Index: peardoc/en/package/php/php-codesniffer.xml
diff -u peardoc/en/package/php/php-codesniffer.xml:1.9 peardoc/en/package/php/php-codesniffer.xml:1.10
--- peardoc/en/package/php/php-codesniffer.xml:1.9	Thu Oct  9 22:35:27 2008
+++ peardoc/en/package/php/php-codesniffer.xml	Mon Jun 29 03:48:40 2009
@@ -4,22 +4,17 @@
   <title>PHP_CodeSniffer</title>
   <abstract>
    <para>
-    PHP_CodeSniffer is a PHP5 script that tokenises
-    and &quot;sniffs&quot; PHP and JavaScript code to detect violations
-    of a defined coding standard.
-    It is an essential development tool that ensures
-    your code remains clean and consistent.
-    It can also help prevent some common semantic
-    errors made by developers.
+    PHP_CodeSniffer is a PHP5 script that tokenises and &quot;sniffs&quot; PHP, JavaScript and CSS files to detect violations of a defined coding standard. It is an essential development tool that ensures your code remains clean and consistent. It can also help prevent some common semantic errors made by developers.
    </para>
   </abstract>
  </info>
 
  <chapter>
-
  &package.php.php-codesniffer.intro;
+ &package.php.php-codesniffer.requirements;
  &package.php.php-codesniffer.usage;
  &package.php.php-codesniffer.advanced-usage;
+ &package.php.php-codesniffer.reporting;
  &package.php.php-codesniffer.config-options;
  &package.php.php-codesniffer.coding-standard-tutorial;
  &package.php.php-codesniffer.coding-standard-class;
http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-codesniffer/reporting.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/package/php/php-codesniffer/reporting.xml
diff -u peardoc/en/package/php/php-codesniffer/reporting.xml:1.1 peardoc/en/package/php/php-codesniffer/reporting.xml:1.2
--- peardoc/en/package/php/php-codesniffer/reporting.xml:1.1	Mon Dec 22 04:00:39 2008
+++ peardoc/en/package/php/php-codesniffer/reporting.xml	Mon Jun 29 03:48:40 2009
@@ -8,7 +8,7 @@
   <refsection><info><title>Printing Full and Summary Reports</title></info>
   <note>
    <simpara>
-   See the main <link linkend="package.php.php-codesniffer.usage">usage</link> page for basic usage information about these report types, including example output.
+   See the main <link linkend="package.php.php-codesniffer.usage">Usage</link> page for basic usage information about these report types, including example output.
    </simpara>
   </note>
   <para>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-codesniffer/svn-pre-commit.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/php/php-codesniffer/svn-pre-commit.xml
diff -u peardoc/en/package/php/php-codesniffer/svn-pre-commit.xml:1.3 peardoc/en/package/php/php-codesniffer/svn-pre-commit.xml:1.4
--- peardoc/en/package/php/php-codesniffer/svn-pre-commit.xml:1.3	Thu Oct  9 15:16:47 2008
+++ peardoc/en/package/php/php-codesniffer/svn-pre-commit.xml	Mon Jun 29 03:48:40 2009
@@ -6,7 +6,11 @@
  </refnamediv>
 
  <refsection xml:id="package.php.php-codesniffer.svn-pre-commit.introduction"><info><title>What Does the Subversion pre-commit Hook Do?</title></info>
-  
+  <note>
+   <simpara>
+   The SVN pre-commit hook has different requirements than the main PHP_CodeSniffer package. See the <link linkend="package.php.php-codesniffer.requirements">Requirements</link> page for more information.
+   </simpara>
+  </note>
   <para>
    A pre-commit hook is a feature available in the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://subversion.tigris.org">Subversion</link> version control system that allows code to be validated before it is committed to the repository. The PHP_CodeSniffer pre-commit hook allows you to check code for coding standard errors and stop the commit process if errors are found. This ensures developers are not able to commit code that violates your coding standard. Instead, they are presented with the list of errors they need to correct before committing.
   </para>

http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-codesniffer/requirements.xml?view=markup&rev=1.1
Index: peardoc/en/package/php/php-codesniffer/requirements.xml
+++ peardoc/en/package/php/php-codesniffer/requirements.xml
<?xml version="1.0" encoding="utf-8"?>
<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-codesniffer.requirements">
 <refnamediv>
  <refname>Requirements</refname>
  <refpurpose>A list of software requirements</refpurpose>
 </refnamediv>

 <refsection>
  <info><title>PHP_CodeSniffer</title></info>
  <para>
   PHP_CodeSniffer requires PHP version 5.1.2 or greater.
  </para>
  <note>
   <simpara>
   Individual sniffs may have additional requirements, such as external applications and scripts. See the <link linkend="package.php.php-codesniffer.config-options">Configuration Options</link> page for a list of these requirements.
   </simpara>
  </note>
 </refsection>

 <refsection>
  <info><title>SVN pre-commit hook</title></info>
  <para>
   The pre-commit hook requires PHP version 5.2.4 or greater due to its use of the vertical whitespace character.
  </para>
 </refsection>

</refentry>