README.txt 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. README.txt for Devel module
  2. ---------------------------
  3. CONTENTS OF THIS FILE
  4. ---------------------
  5. * Introduction
  6. * Requirements
  7. * Included Modules and Features
  8. * Recommended Modules
  9. * Installation
  10. * Compatibility Notes
  11. * Maintainers
  12. INTRODUCTION
  13. ------------
  14. A module containing helper functions for Drupal developers and inquisitive
  15. admins. This module can print a log of all database queries for each page
  16. request at the bottom of each page. The summary includes how many times each
  17. query was executed on a page, and how long each query took.
  18. - For a full description of the module visit:
  19. https://www.drupal.org/project/devel
  20. - To submit bug reports and feature suggestions, or to track changes visit:
  21. https://www.drupal.org/project/issues/devel
  22. It also offers
  23. - a block for running custom PHP on a page
  24. - a block for quickly accessing devel pages
  25. - a block for masquerading as other users (useful for testing)
  26. - reports memory usage at bottom of page
  27. - A mail-system class which redirects outbound email to files
  28. - more
  29. This module is safe to use on a production site. Just be sure to only grant
  30. 'access development information' permission to developers.
  31. Also a dpr() function is provided, which pretty prints arrays and strings.
  32. Useful during development. Many other nice functions like dpm(), dvm().
  33. AJAX developers in particular ought to install FirePHP Core from
  34. http://www.firephp.org/ and put it in the devel directory. You may use the
  35. devel-download drush command to download the library. If downloading by hand,
  36. your path to fb.php should look like
  37. devel/FirePHPCore/lib/FirePHPCore/fb.php. You can use svn checkout
  38. http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore.
  39. Then you can log php variables to the Firebug console. Is quite useful.
  40. REQUIREMENTS
  41. ------------
  42. This module requires no modules outside of Drupal core.
  43. INCLUDED MODULES AND FEATURES
  44. -----------------------------
  45. Included in this package is also:
  46. - Devel Node Access module - Prints out the node_access records for a given
  47. node. Also offers hook_node_access_explain for all node access modules to
  48. implement. Handy.
  49. - Devel Generate module - Bulk creates nodes, users, comment, terms for
  50. development.
  51. Some nifty drush integration ships with Devel and Devel Generate. See drush help
  52. for details.
  53. DRUSH UNIT TEST - See develDrushTest.php for an example of unit testing of the
  54. Drush integration. This uses Drush's own test framework, based on PHPUnit. To
  55. run the tests, use
  56. phpunit --bootstrap=/path/to/drush/tests/drush_testcase.inc. Note that we must
  57. name a file under /tests there.
  58. RECOMMENDED MODULE
  59. ------------------
  60. Devel Generate Extensions - Devel Images Provider allows to configure external
  61. providers for images.
  62. - http://drupal.org/project/devel_image_provider
  63. INSTALLATION
  64. ------------
  65. - Install the Devel module as you would normally install a contributed Drupal
  66. module. Visit https://www.drupal.org/node/895232 for further information.
  67. COMPATIBILITY NOTES
  68. -------------------
  69. - Modules that use AHAH may have incompatibility with the query log and other
  70. footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE if you run
  71. into any issues.
  72. AUTHOR/MAINTAINER
  73. -----------------
  74. - Moshe Weitzman (moshe weitzman) - https://www.drupal.org/u/moshe-weitzman
  75. - Hans Salvisberg (salvis) - https://www.drupal.org/u/salvis