more documentation rST fixes

This commit is contained in:
Christian Weiske 2011-05-26 21:44:29 +02:00
parent b55b3a6c67
commit 17dcda30e7
3 changed files with 33 additions and 23 deletions

View file

@ -217,6 +217,7 @@
<include name="doc/**.rst"/> <include name="doc/**.rst"/>
<include name="doc/**/*.rst"/> <include name="doc/**/*.rst"/>
<exclude name="doc/LICENSE.txt"/> <exclude name="doc/LICENSE.txt"/>
<exclude name="doc/developers/TODO.rst"/>
</fileset> </fileset>
</foreach> </foreach>
</target> </target>

View file

@ -4,17 +4,21 @@ How to debug SemanticScuttle
Database queries Database queries
---------------- ----------------
In config.php, enable debugMode.
Further, add the following there: In ``data/config.php``, enable ``debugMode``.
------- Further, add the following afterwards: ::
register_shutdown_function(
create_function('', <<<FNC register_shutdown_function(
\$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb(); create_function('', <<<FNC
\$GLOBALS['db']->sql_report('display'); \$GLOBALS['db'] = SemanticScuttle_Service_Factory::getDb();
FNC \$GLOBALS['db']->sql_report('display');
) FNC
); )
------ );
To see database queries in SemanticScuttle, add
> ?explain=1
To see database queries in SemanticScuttle, add ::
?explain=1
to your URL. to your URL.

View file

@ -1,21 +1,26 @@
Running unit tests Running unit tests
================== ==================
Go to the SemanticScuttle main directory and run Go to the SemanticScuttle ``tests`` directory and run ``phpunit``::
$ php tests/AllTests.php
or
$ phpunit tests/AllTests.php
also remember the --verbose parameter to PHPUnit.
If you want to run a specific test class only: $ cd tests
$ phpunit tests/BookmarksTest.php $ 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 $ phpunit --filter BookmarkTest::testUnificationOfBookmarks tests/BookmarkTest.php
Caveats Caveats
------- -------
Having debugging enabled and database driver "mysql4" activated Having debugging enabled and database driver "``mysql4``" activated
will lead to failing tests because of FOUND_ROWS() usage, which will lead to failing tests because of ``FOUND_ROWS()`` usage, which
does not work nicely with database debugging. does not work nicely with database debugging.