doc: Mention optional linux dependencies.

[apitrace] / INSTALL.markdown

diff --git a/INSTALL.markdown b/INSTALL.markdown
index b4c99e8826c860c2fe651ac66b01dc88eb384e36..22c3f5e402039d31de913815abc53d1109a7406f 100644 (file)
--- a/INSTALL.markdown
+++ b/INSTALL.markdown
@@ -16,12 +16,12 @@ Requirements common for all platforms:
 
 The GUI also dependends on:
 
 
 The GUI also dependends on:
 

-* Qt version 4.7
+* Qt version 4.7 or higher (tested with version 4.8)

 
 * QJSON version 0.5 or higher (tested with version 0.7.1, which is bundled)
 
 
 * QJSON version 0.5 or higher (tested with version 0.7.1, which is bundled)
 

-Qt and QJSON will be required if `-DENABLE_GUI=TRUE` is passed to `cmake`, and
-never used if `-DENABLED_GUI=FALSE` is passed instead.  The implicit default is
+Qt and QJSON will be required if `-DENABLE_GUI=TRUE` is passed to CMake, and
+never used if `-DENABLE_GUI=FALSE` is passed instead.  The implicit default is

 `-DENABLE_GUI=AUTO`, which will build the GUI if Qt is available, using the
 bundled QJSON if it is not found on the system.
 
 `-DENABLE_GUI=AUTO`, which will build the GUI if Qt is available, using the
 bundled QJSON if it is not found on the system.
 


@@ -35,17 +35,35 @@ tracing.
 Linux / Mac OS X
 ----------------
 
 Linux / Mac OS X
 ----------------
 

+Additional optional dependencies for Linux:
+
+* libprocps (procps development libraries)
+
+* libdwarf
+
+

 Build as:
 
     cmake -H. -Bbuild
     make -C build
 
 Build as:
 
     cmake -H. -Bbuild
     make -C build
 

-You can also build the 32bit GL wrapper on 64bit distro with a multilib gcc by
-doing:

 
 

-    cmake -H. -Bbuild32 -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_EXE_LINKER_FLAGS=-m32 -DENABLE_GUI=FALSE
+You can also build the 32-bits GL wrapper on a 64-bits distribution, provided
+you have a multilib gcc and 32-bits X11 libraries, by doing:
+
+    cmake \
+        -DCMAKE_C_FLAGS=-m32 \
+        -DCMAKE_CXX_FLAGS=-m32 \
+        -DCMAKE_EXE_LINKER_FLAGS=-m32 \
+        -DCMAKE_SYSTEM_LIBRARY_PATH=/usr/lib32 \
+        -DENABLE_GUI=FALSE \
+        -H. -Bbuild32

     make -C build32 glxtrace
 
     make -C build32 glxtrace
 

+The `/usr/lib32` refers to the path where the 32-bits shared objects are may
+differ depending on the actual Linux distribution.
+
+

 Android
 -------
 
 Android
 -------
 


@@ -59,6 +77,19 @@ Build as:
     cmake -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain/android.toolchain.cmake -DANDROID_API_LEVEL=9 -H. -Bbuild
     make -C build
 
     cmake -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain/android.toolchain.cmake -DANDROID_API_LEVEL=9 -H. -Bbuild
     make -C build
 

+You can also choose a particular ABI by passing `ANDROID_ABI` variable to
+cmake, e.g., `-DANDROID_ABI=x86`.
+
+FirefoxOS
+---------
+
+Put Apitrace source tree into `B2GROOT/external/apitrace/` and the `Android.mk`
+file (`B2GROOT/external/apitrace/Android.mk`) will do the needful to compile
+and install apitrace appropriately into the system image as part of FirefoxOS
+build process. It expects a linaro-type of Android NDK to be present in
+`../../prebuilt/ndk/android-ndk-r7` (ie `B2GROOT/prebuilt/ndk/android-ndk-r7`).
+
+

 Windows
 -------
 
 Windows
 -------
 


@@ -84,7 +115,7 @@ Additional requirements:
 
 To build with Visual Studio first invoke CMake GUI as:
 
 
 To build with Visual Studio first invoke CMake GUI as:
 

-    cmake-gui -H. -B%cd%\build
+    cmake-gui -H%cd% -B%cd%\build

 
 and press the _Configure_ button.
 
 
 and press the _Configure_ button.
 


@@ -93,14 +124,14 @@ not found automatically, you can manually specify the location of the
 dependencies from the CMake GUI.
 
 After you've successfully configured, you can start the build by opening the
 dependencies from the CMake GUI.
 
 After you've successfully configured, you can start the build by opening the

-generated `build\apitrace.sln` solution file, or invoking `cmake` as:
+generated `build\apitrace.sln` solution file, or invoking CMake as:

 
     cmake --build build --config MinSizeRel
 
 The steps to build 64bit version are similar, but choosing _Visual Studio 10
 Win64_ instead of _Visual Studio 10_.
 
 
     cmake --build build --config MinSizeRel
 
 The steps to build 64bit version are similar, but choosing _Visual Studio 10
 Win64_ instead of _Visual Studio 10_.
 

-It's also possible to instruct `cmake` build Windows binaries on Linux with
+It's also possible to instruct CMake build Windows binaries on Linux with

 [MinGW cross compilers](http://www.cmake.org/Wiki/CmakeMingw).
 
 
 [MinGW cross compilers](http://www.cmake.org/Wiki/CmakeMingw).