modetest: add pageflip test case to modetest

[android-x86/external-libdrm.git] / README

diff --git a/README b/README
index b466dd8..b6008a0 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,72 @@
-By default, this will install into /usr/local.  If you want to install this
-libdrm to replace your system copy, say:
 
-./configure --prefix=/usr --exec-prefix=/
+DRM README file
+
+
+There are two main parts to this package: the DRM client library/interface
+(libdrm.so) and kernel/hardware-specific device modules (such as radeon.ko).
+The kernel device modules are not shipped with libdrm releases and should only
+be built from the git tree by developers and bleeding-edge testers of
+non-Intel hardware.  The Intel kernel modules are developed in the Linux
+kernel tree.
+
+
+Compiling
+---------
+
+By default, libdrm and the DRM header files will install into /usr/local/.
+If you want to install this DRM to replace your system copy, say:
+
+       ./configure --prefix=/usr --exec-prefix=/
+
+Then,
+       make install
+
+
+To build the device-specific kernel modules from the git tree:
+
+       cd linux-core/
+       make
+       cp *.ko /lib/modules/VERSION/kernel/drivers/char/drm/
+          (where VERSION is your kernel version: uname -f)
+
+Or,
+       cd bsd-core/
+       make
+       copy the kernel modules to the appropriate place
+
+
+
+Tips & Trouble-shooting
+-----------------------
+
+1. You'll need kernel sources.  If using Fedora Core 5, for example, you may
+   need to install RPMs such as:
+
+       kernel-smp-devel-2.6.15-1.2054_FC5.i686.rpm
+       kernel-devel-2.6.15-1.2054_FC5.i686.rpm
+       etc.
+
+
+2. You may need to make a symlink from /lib/modules/VERSION/build to your
+   kernel sources in /usr/src/kernels/VERSION (where version is `uname -r`):
+
+       cd /lib/modules/VERSION
+       ln -s /usr/src/kernels/VERSION build
+
+
+3. If you've build the kernel modules but they won't load because of an
+   error like this:
+
+       $ /sbin/modprobe drm
+       FATAL: Error inserting drm (/lib/modules/2.6.15-1.2054_FC5smp/kernel/drivers/char/drm/drm.ko): Invalid module format
+
+   And 'dmesg|tail' says:
+
+       drm: disagrees about version of symbol struct_module 
+
+   Try recompiling your drm modules without the Module.symvers file.
+   That is rm the /usr/src/kernels/2.6.15-1.2054_FC5-smp-i686/Module.symvers
+   file (or rename it).  Then do a 'make clean' before rebuilding your drm
+   modules.
+
+