changeset
Update README for debug extension
Mon, 27 Jul 2009 03:32:28 +0100
- author
- Matthew Wild <mwild1@gmail.com>
- date
- Mon, 27 Jul 2009 03:32:28 +0100
- changeset 35
- 8843ea9f9e27
- parent 34
- 0e34461ab2a6
- child 36
- bbfbc08d568f
Update README for debug extension
| README | file | annotate | diff | comparison | revisions |
--- a/README Mon Jul 27 03:32:13 2009 +0100 +++ b/README Mon Jul 27 03:32:28 2009 +0100 @@ -47,6 +47,18 @@ #### --compile Enables compilation of the output file. +### Debug +Due to the way Squish combines multiple scripts into one, sometimes when a squished script raises an error the traceback +will be fairly unhelpful, and point to a line in the unreadable squished script. This is where the debug extension comes in! + +#### --enable-debug +This option includes some code into the squished file which will restore the filenames and line numbers in error messages and +tracebacks. This option will increase the size of the output by no more than about 6KB, so may be very much worth it when +squishing large tricky-to-debug applications and libraries. + +**Note:** Minification may interfere with the line number calculation, use --minify-level=debug to enable all features of minify +that don't change line numbers, and everything will be fine. + ## Squishy reference A squishy file is actually a Lua script which calls some Squish functions. These functions are listed here.
