cairo/util/README
Behdad Esfahbod 5926257770 Revamp the build system.
Quick summary of changes:

  - Move list of cairo source files out of src/Makefile.am and into
    src/Sources.mk,

  - Generate files src/Config.mk and src/Config.mk.win32 that choose
    the right set of source files and headers based on configured
    backends and features.  This drastically simplifies building
    using other build systems.  The src/Makefile.win32 file needs
    to be updated to reflect these changes.

  - Add README files to various directories,

  - Add toplevel HACKING file.
2008-09-02 20:24:08 -04:00

69 lines
1.7 KiB
Text

Cairo Utilities
===============
There are a varieties of utilities we use with cairo.
backtrace-symbols
-----------------
This is a small shared library designed to be preloaded by the
linker and its purpose is to make the backtrace_symbols() function
of glibc produce more useful source reference information.
Build by:
make backtrace-symbols.so
and use by:
LD_PRELOAD=$PWD/backtrace-symbols.so app-to-run
This code should be contributed back to glibc at some point.
malloc-stats
------------
This is a small shared library designed to be preloaded by the
linker and its purpose is to make the malloc_stats() function
of glibc produce more useful information.
Build by:
make malloc-stats.so
and use by:
LD_PRELOAD=$PWD/malloc-stats.so app-to-run
This works best when backtrace-symbols is in use. That is:
LD_PRELOAD="$PWD/backtrace-symbols.so $PWD/malloc-stats.so" app-to-run
cairo-trace
-----------
This tool can be used to trace all the cairo function calls made by an
applications. This is useful for either extracting a test case triggering
a bug from an application, or simply to get a general idea of how an
application is using cairo.
This tool lives outside the cairo source distribution right now and can
be found in a git repository at:
http://cgit.freedesktop.org/~ickle/cairo-trace/
There are plans to move it to this directory in the future, and possibly
install it on the system.
cairo-api-update and xr2cairo
-----------------------------
These two scripts were used to convert source code written for pre-1.0
cairo to newer API. See $(top_srcdir)/PORTING_GUIDE for more information.
These files are obsolete now and may be removed in a future version.