diff options
| -rw-r--r-- | build.xml | 1 | ||||
| -rw-r--r-- | doc/developers/debugging.rst | 30 | ||||
| -rw-r--r-- | doc/developers/running-unit-tests.rst | 25 |
3 files changed, 33 insertions, 23 deletions
@@ -217,6 +217,7 @@ <include name="doc/**.rst"/> <include name="doc/**/*.rst"/> <exclude name="doc/LICENSE.txt"/> + <exclude name="doc/developers/TODO.rst"/> </fileset> </foreach> </target> diff --git a/doc/developers/debugging.rst b/doc/developers/debugging.rst index 7f84da6..6bee309 100644 --- a/doc/developers/debugging.rst +++ b/doc/developers/debugging.rst @@ -4,17 +4,21 @@ How to debug SemanticScuttle Database queries ---------------- -In config.php, enable debugMode. -Further, add the following there: -------- -register_shutdown_function( - create_function('', <<<FNC -\$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb(); -\$GLOBALS['db']->sql_report('display'); -FNC - ) -); ------- -To see database queries in SemanticScuttle, add -> ?explain=1 + +In ``data/config.php``, enable ``debugMode``. +Further, add the following afterwards: :: + + register_shutdown_function( + create_function('', <<<FNC + \$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb(); + \$GLOBALS['db']->sql_report('display'); + FNC + ) + ); + + +To see database queries in SemanticScuttle, add :: + + ?explain=1 + to your URL. diff --git a/doc/developers/running-unit-tests.rst b/doc/developers/running-unit-tests.rst index 556055f..8b0fa0d 100644 --- a/doc/developers/running-unit-tests.rst +++ b/doc/developers/running-unit-tests.rst @@ -1,21 +1,26 @@ Running unit tests ================== -Go to the SemanticScuttle main directory and run - $ php tests/AllTests.php -or - $ phpunit tests/AllTests.php -also remember the --verbose parameter to PHPUnit. +Go to the SemanticScuttle ``tests`` directory and run ``phpunit``:: -If you want to run a specific test class only: - $ phpunit tests/BookmarksTest.php + $ cd tests + $ phpunit . -If you need to test one method only: +also remember the ``--verbose`` parameter to PHPUnit. + +If you want to run a specific test class only: :: + + $ cd tests + $ phpunit BookmarksTest.php + +If you need to test one method only: :: + + $ cd tests $ phpunit --filter BookmarkTest::testUnificationOfBookmarks tests/BookmarkTest.php Caveats ------- -Having debugging enabled and database driver "mysql4" activated -will lead to failing tests because of FOUND_ROWS() usage, which +Having debugging enabled and database driver "``mysql4``" activated +will lead to failing tests because of ``FOUND_ROWS()`` usage, which does not work nicely with database debugging. |