README.txt 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. README.txt
  2. ==========
  3. A module containing helper functions for Drupal developers and
  4. inquisitive admins. This module can print a log of
  5. all database queries for each page request at the bottom of each page. The
  6. summary includes how many times each query was executed on a page, and how long
  7. each query took.
  8. It also offers
  9. - a block for running custom PHP on a page
  10. - a block for quickly accessing devel pages
  11. - a block for masquerading as other users (useful for testing)
  12. - reports memory usage at bottom of page
  13. - A mail-system class which redirects outbound email to files
  14. - more
  15. This module is safe to use on a production site. Just be sure to only grant
  16. 'access development information' permission to developers.
  17. Also a dpr() function is provided, which pretty prints arrays and strings.
  18. Useful during development. Many other nice functions like dpm(), dvm().
  19. AJAX developers in particular ought to install FirePHP Core from
  20. http://www.firephp.org/ and put it in the devel directory.
  21. This happens automatically when you enable via drush. You may also
  22. use a drush command to download the library. If downloading by hand,
  23. your path to fb.php should look like devel/FirePHPCore/lib/FirePHPCore/fb.php.
  24. You can use svn checkout http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore.
  25. Then you can log php variables to the Firebug console. Is quite useful.
  26. Included in this package is also:
  27. - devel_node_access module which prints out the node_access records for a given node. Also offers hook_node_access_explain for all node access modules to implement. Handy.
  28. - devel_generate.module which bulk creates nodes, users, comment, terms for development
  29. Some nifty drush integration ships with devel and devel_generate. See drush help for details.
  30. COMPATIBILITY NOTES
  31. ==================
  32. - Modules that use AHAH may have incompatibility with the query log and other
  33. footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE if you run into
  34. any issues.
  35. DRUSH UNIT TEST
  36. ==================
  37. See develDrushTest.php for an example of unit testing of the Drush integration.
  38. This uses Drush's own test framework, based on PHPUnit. To run the tests, use
  39. phpunit --bootstrap=/path/to/drush/tests/drush_testcase.inc. Note that we must name a file
  40. under /tests there.
  41. AUTHOR/MAINTAINER
  42. ======================
  43. -moshe weitzman <weitzman at tejasa DOT com>
  44. http://cyrve.com
  45. Hans Salvisberg <drupal at salvisberg DOT com>