#1113940 by asimmonds: Fixed array warnings when generating content.
[project/devel.git] / README.txt
1 README.txt
2 ==========
3
4 A module containing helper functions for Drupal developers and
5 inquisitive admins. This module can print a log of
6 all database queries for each page request at the bottom of each page. The
7 summary includes how many times each query was executed on a page, and how long
8 each query took.
9  
10  It also offers
11  - a block for running custom PHP on a page
12  - a block for quickly accessing devel pages
13  - a block for masquerading as other users (useful for testing)
14  - reports memory usage at bottom of page
15  - more
16  
17  This module is safe to use on a production site. Just be sure to only grant
18  'access development information' permission to developers.
19
20 Also a dpr() function is provided, which pretty prints arrays and strings.
21 Useful during development. Many other nice functions like dpm(), dvm().
22
23 AJAX developers in particular ought to install FirePHP Core from
24 http://www.firephp.org/ and put it in the devel directory. 
25 This happens automatically when you enable via drush. You may also
26 use a drush command to download the library. If downloading by hand, 
27 your path to fb.php should look like devel/FirePHPCore/lib/FirePHPCore/fb.php. 
28 You can use svn checkout http://firephp.googlecode.com/svn/trunk/trunk/Libraries/FirePHPCore.
29 Then you can log php variables to the Firebug console. Is quite useful.
30
31 Included in this package is also: 
32
33 - 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.
34 - devel_generate.module which bulk creates nodes, users, comment, terms for development
35
36 Some nifty drush integration ships with devel and devel_generate. See drush help for details.
37
38 COMPATIBILITY NOTES
39 ==================
40 - Modules that use AHAH may have incompatibility with the query log and other
41   footer info. Consider setting $GLOBALS['devel_shutdown'] = FALSE if you run into
42   any issues.
43
44 AUTHOR/MAINTAINER
45 ======================
46 -moshe weitzman <weitzman at tejasa DOT com>
47 http://cyrve.com
48 Hans Salvisberg <drupal at salvisberg DOT com>