diff options
author | Chad Versace <chad.versace@linux.intel.com> | 2013-08-19 19:39:16 -0700 |
---|---|---|
committer | Chad Versace <chad.versace@linux.intel.com> | 2013-08-19 23:04:56 -0700 |
commit | 5b9998c523b7096a938c5917832c9ad6033ab0ea (patch) | |
tree | 215abfef02b49ddbae9d190898ab282e72689cb5 /doc | |
parent | bc298fa384a0b928e6b9de1b9f2f0091bd2b90b5 (diff) |
doc: Remove building.txt
This file did several things, each not worth doing.
1. Give a basic CMake tutorial.
(It's not Waffle's responsibility to give a half-baked CMake
tutorial.)
2. List all of Waffle's custom CMake options.
(This is now covered by Options.cmake).
3. List some important make targets
(This will quickly become out-of-date).
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/building.txt | 146 |
1 files changed, 0 insertions, 146 deletions
diff --git a/doc/building.txt b/doc/building.txt deleted file mode 100644 index 1ab1a2b..0000000 --- a/doc/building.txt +++ /dev/null @@ -1,146 +0,0 @@ -Quickstart -========== - -For basic build instructions that should work for most users, see the README. - - -Configuration -============= - -If any of Waffle's dependencies are installed in custom locations, you must -set the PKG_CONFIG_PATH environment variable. - -To configure Waffle, invoke CMake as `cmake [options] $WAFFLE_SOURCE_DIR`. -Options are given in form `-Dname=value`. CMake stores its configuration in a -top-level file named CMakeCache.txt. To edit cached variables, either edit the -file by hand or call `make edit_cache`. - -CMake builtin options: - - CMake has many builtin options. Here is a small subset of important - options that affect Waffle. - - - CMAKE_INSTALL_PREFIX - [default=/usr/local] - Equivalent to autoconf's --prefix. - - - CMAKE_INSTALL_INCLUDEDIR - [default=include] - Equivalent to autoconf's --includedir. - Relative paths are interpreted relative to CMAKE_INSTALL_PREFIX. - - - CMAKE_INSTALL_LIBDIR - [default=lib or lib64, system-dependent] - Equivalent to autoconf's --libdir. - Relative paths are interpreted relative to CMAKE_INSTALL_PREFIX. - - - CMAKE_INSTALL_DOCDIR - [default=${CMAKE_INSTALL_DATAROOTDIR}/doc/waffle-${MAJOR_VERSION}] - Equivalent to autoconf's --docdir. - Relative paths are interpreted relative to CMAKE_INSTALL_PREFIX. - - - CMAKE_BUILD_TYPE - [default=?; choices=debug,release] - This affects compilation flags. - - - CMAKE_C_FLAGS - [default="--std=c99 -Wall -Werror"] - - - CMAKE_C_FLAGS_DEBUG - [default="-g3 -O0 -DDEBUG"] - Flags to append to CMAKE_C_FLAGS when CMAKE_BUILD_TYPE=debug. - - - CMAKE_C_FLAGS_RELEASE - [default="-g1 -O2 -DNEDEBUG"] - Flags to append to CMAKE_C_FLAGS when CMAKE_BUILD_TYPE=release. - -Platform options; - - - waffle_has_gbm - [default=0] [choices=0,1] - Build Waffle with support for GBM. - - - waffle_has_glx - [default=0] [choices=0,1] - Build Waffle with support for GLX. - - - waffle_has_wayland - [default=0] [choices=0,1] - Build Waffle with support for Wayland. - - - waffle_has_x11_egl - [default=0] [choices=0,1] - Build Waffle with support for X11/EGL. - -Miscellaneous options: - - - waffle_build_manpages - [default=0; choices=0,1] - Build and install the manpages. - - - waffle_build_htmldocs - [default=0; choices=0,1] - Build and install html documentation. - - - waffle_build_tests - [default=1; choices=0,1] - Build the unit tests and functional tests ran by `make check` and - `make check-func`. - - - waffle_build_examples - [default=1; choices=0,1] - Build the stuff in the /examples directory. - - -Building and Installing -======================= - -To build and install Waffle: - - make - make install - -I strongly recommend you run `make check` before installing. - -What follows is a list of significant build targets. - -Generic targets: - - - all - Build everything. - - - check - Run unit tests. - - - check-func - Run functional tests as well as unit tests. - - - install - -Libraries: - - - waffle - Waffle's main library. - - - waffle_test - Waffle's test framework. - -Test programs: - - - waffle-unittest - - gl_basic_test - -Example programs: - - - gl_basic - - simple-x11-egl - -CMake targets: - - - help - List all make targets. - - - edit_cache - Edit CMakeCache.txt. - - - rebuild_cache |