Merge branch 'MDL-37523_M23' of git://github.com/lazydaisy/moodle into MOODLE_23_STABLE
[moodle.git] / lib / xhprof / readme_moodle.txt
blob6168abd7b7fec7bcb2f1ecfaf7efb95905b61c5e
1 Description of XHProf 0.9.2 library/viewer import into Moodle
3 Removed:
4  * examples - examples dir removed completely
5  * extension - extension dir removed completely
6  * package.xml - PECL package definition removed completely
7  * xhprof_html/docs - documentation dir removed completely
9 Added:
10  * index.html - prevent directory browsing on misconfigured servers
11  * xhprof_moodle.php - containing all the stuff needed to run the xhprof profiler within Moodle
12  * readme_moodle.txt - this file ;-)
14 Our changes:  Look for "moodle" in code
15  * xhprof_html/index.php  ----|
16  * xhprof_html/callgraph.php -|=> Changed to use own DB iXHProfRuns implementation (moodle_xhprofrun)
17  * xhprof_html/typeahead.php -|
18  * xhprof_html/css/xhprof.css: Minor tweaks to report styles
19  * xhprof_lib/utils/callgraph_utils.php: Modified to use $CFG->pathtodot
21 TODO:
22  * with the 3 reports (index, callgraph and typeahead), close seesion asap,
23        so user can continue working with moodle while the report (specially
24        the graph is being generated).
25  * export/import profiling runs: Allow to pick any profile record, encapsulate
26        it into some serialized/encoded way and allow download/upload. It requires
27        DB changes in order to be able to specify the source of each record (own/imported).
28  * improvements to the listing mode: various commodity details like:
29        - allow to filter by various criteria
30        - inline (and ajax) editing of reference/comment and deleting
31        - whatever daily usage discovers ;-)
32  * add new settings to control if we want to profile things like:
33        - php functions
34        - memory
35        - cpu times
36        (all them are right now enabled for everybody by default)
38 20101122 - MDL-24600 - Eloy Lafuente (stronk7): Original import of 0.9.2 release
39 20110318 - MDL-26891 - Eloy Lafuente (stronk7): Implemented earlier profiling runs