summaryrefslogtreecommitdiff
path: root/_cs/README
diff options
context:
space:
mode:
authorAndreas Gohr <andi@splitbrain.org>2009-10-18 19:20:36 +0200
committerAndreas Gohr <andi@splitbrain.org>2009-10-18 19:20:36 +0200
commit673c04e7e3f11d45a51bd7d9e6505e3200c5bcb7 (patch)
tree36268b4a8e2dbfd87e20c53369f55a4c230f6c66 /_cs/README
parent2709b4569c04bc8a1cb7933e1a5d726a7afc5be0 (diff)
downloadrpg-673c04e7e3f11d45a51bd7d9e6505e3200c5bcb7.tar.gz
rpg-673c04e7e3f11d45a51bd7d9e6505e3200c5bcb7.tar.bz2
PHP CodeSniffer Coding standard setup
Ignore-this: a7df997caaa37d97734bbf2afd969e0d A first try to define a testable coding standard for DokuWiki. This is still missing a few tests and also fails for a lot of things in DokuWiki. darcs-hash:20091018172036-7ad00-7edf5cb732f82d6ad7d1112a24d0c0b8b2d6452f.gz
Diffstat (limited to '_cs/README')
-rw-r--r--_cs/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/_cs/README b/_cs/README
new file mode 100644
index 000000000..7aac73161
--- /dev/null
+++ b/_cs/README
@@ -0,0 +1,18 @@
+This directory contains the Coding Standard tests to be used with PHP
+CodeSniffer on DokuWiki's code.
+
+1. Install PHP CodeSniffer:
+
+ #> pear install PHP_CodeSniffer
+
+2. Link the Coding Standard to the CodeSniffer directory:
+
+ #> ln -s /path/to/dokuwiki/_cs/DokuWiki /usr/share/pear/PHP/CodeSniffer/Standards/DokuWiki
+
+3. Set DokuWiki to be the default standard:
+
+ #> phpcs --config-set default_standard DokuWiki
+
+
+
+The coding standard is work in progress.