Revision: 6384
http://playerstage.svn.sourceforge.net/playerstage/?rev=6384&view=rev
Author: gbiggs
Date: 2008-04-23 23:25:45 -0700 (Wed, 23 Apr 2008)
Log Message:
-----------
Replaced INSTALL with CMake instructions
Modified Paths:
--------------
code/player/trunk/INSTALL
Removed Paths:
-------------
code/player/trunk/CMake_README.txt
Deleted: code/player/trunk/CMake_README.txt
===================================================================
--- code/player/trunk/CMake_README.txt 2008-04-24 06:04:37 UTC (rev 6383)
+++ code/player/trunk/CMake_README.txt 2008-04-24 06:25:45 UTC (rev 6384)
@@ -1,23 +0,0 @@
-The best way to use this stuff is to perform an out-of-source build. In-source
-builds make a mess of the source tree (just like with autotools). Create a
-directory somewhere (I make a subdir of the root dir called build/), change to
-it and execute "cmake <path to source root>" (for me, "cmake ../"). This will
-run the configuration and create the make files for the system in use. Then run
-make to build it, and make install to install it
-
-$ cd ~/src/player_cmake/
-$ mkdir build
-$ cd build/
-$ cmake ../ [or ccmake ../ if there are options you want to change]
-$ make install
-
-If you want to change build options, you could do it the old-fashioned way
-using cmake, or you could replace cmake with ccmake in your command to change
-them using an ncurses-based GUI. You might want to change CMAKE_INSTALL_PREFIX
-so it doesn't install over your current copy of player.
-
-To get under the hood and see the actual compile / link lines (very helpful
-in debugging build problems):
-
-$ make VERBOSE=1
-
Modified: code/player/trunk/INSTALL
===================================================================
--- code/player/trunk/INSTALL 2008-04-24 06:04:37 UTC (rev 6383)
+++ code/player/trunk/INSTALL 2008-04-24 06:25:45 UTC (rev 6384)
@@ -1,239 +1,108 @@
-Installation Instructions
-*************************
+The Player build system uses CMake (http://cmake.org/HTML/index.html). There
+are two ways of conducting a CMake-based build: in-source builds and
+out-of-source builds. An out-of-source build is the preferred option.
-Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
-2006 Free Software Foundation, Inc.
+Out-of-source Build
+===================
-This file is free documentation; the Free Software Foundation gives
-unlimited permission to copy, distribute and modify it.
+Create a directory anywhere you have permission. Typically, a subdirectory of
+the source directory is used:
-TEMPORARY NOTICE:
-until this document is updated for cmake please see README for basic build
-procedures
+$ cd player/
+$ mkdir build
+$ cd build/
+This directory will be the destination for the generated build scripts, any
+files generated during the build process, the compiled objects, as well as
+executables and libraries before they are installed.
-Basic Installation
-==================
+Once in your chosen build location, you have a choice of two ways to exectute
+CMake and generate the build scripts for your build system (such as make,
+KDevelop, mingw, Microsoft Visual Studio, etc):
-Briefly, the shell commands `./configure; make; make install' should
-configure, build, and install this package. The following
-more-detailed instructions are generic; see the `README' file for
-instructions specific to this package.
+1) Use the command-line cmake:
- The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation. It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions. Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, and a
-file `config.log' containing compiler output (useful mainly for
-debugging `configure').
+$ cmake ../
- It can also use an optional file (typically called `config.cache'
-and enabled with `--cache-file=config.cache' or simply `-C') that saves
-the results of its tests to speed up reconfiguring. Caching is
-disabled by default to prevent problems with accidental use of stale
-cache files.
+The configure process will run, with the checks being performed and the result
+of the configuration, including which drivers and client libraries will be
+built, printed to standard out.
- If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release. If you are using the cache, and at
-some point `config.cache' contains results you don't want to keep, you
-may remove or edit it.
+Configuration options can be changed using the -D command line option. Run
+"cmake --help" for details. A full list of configuration options for Player is
+given below.
- The file `configure.ac' (or `configure.in') is used to create
-`configure' by a program called `autoconf'. You need `configure.ac' if
-you want to change it or regenerate `configure' using a newer version
-of `autoconf'.
+2) Use the ncurses-based (for Unix-like systems) or graphical (for Windows) UI:
-The simplest way to compile this package is:
+$ ccmake ../
- 1. `cd' to the directory containing the package's source code and type
- `./configure' to configure the package for your system.
+This is the preferred option if you need to change a configuration variable,
+as it is much easier.
- Running `configure' might take a while. While running, it prints
- some messages telling which features it is checking for.
+The first time the UI runs, you will need to press 'c' to perform the initial
+configuration pass. After this, configurable variables will be displayed.
+To change a value, select it and press "enter," followed by entering the new
+value and pressing "enter" again. Press 'c' to reconfigure after changing the
+variables to meet your needs. New variables may appear after each configure
+pass.
- 2. Type `make' to compile the package.
+In the UI, you can also press 't' to switch to advanced mode. This will display
+a larger number of configuration options. Most will correspond to internal
+CMake variables, but some may correspond to advanced Player options.
- 3. Optionally, type `make check' to run any self-tests that come with
- the package.
+Once all variables have been set to your satisfaction, continue pressing 'c'
+until the generate option becomes available at the bottom of the screen. This
+indicates that CMake is ready to generate the build scripts, so press 'g' to
+tell it to do so.
- 4. Type `make install' to install the programs and any data files and
- documentation.
+You are now ready to compile and install Player. How you do this will depend
+on the build system you have chosen to use. The example below is for Unix
+Makefiles.
- 5. You can remove the program binaries and object files from the
- source code directory by typing `make clean'. To also remove the
- files that `configure' created (so you can compile the package for
- a different kind of computer), type `make distclean'. There is
- also a `make maintainer-clean' target, but that is intended mainly
- for the package's developers. If you use it, you may have to get
- all sorts of other programs in order to regenerate files that came
- with the distribution.
+$ make
+$ make install
-Compilers and Options
-=====================
+If errors occur during the build process and you want more information on the
+build steps performed (this is particularly important if you are seeking help
+from the mailing list), perform a verbose make:
-Some systems require unusual options for compilation or linking that the
-`configure' script does not know about. Run `./configure --help' for
-details on some of the pertinent environment variables.
+$ VERBOSE=1 make
- You can give `configure' initial values for configuration parameters
-by setting variables in the command line or in the environment. Here
-is an example:
- ./configure CC=c99 CFLAGS=-g LIBS=-lposix
+In-source Build
+===============
- *Note Defining Variables::, for more details.
+An in-source build is not recommended, as it pollutes the source tree with the
+generated build scripts and makes completely removing all generated scripts
+difficult.
-Compiling For Multiple Architectures
-====================================
+The steps to perform an in-source build are, for the most part, the same as for
+an out-of-source build. Instead of creating a new directory, simply change to
+the source directory and run cmake (or ccmake):
-You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory. To do this, you can use GNU `make'. `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script. `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
+$ cd player/
+$ cmake .
+$ make install
- With a non-GNU `make', it is safer to compile the package for one
-architecture at a time in the source code directory. After you have
-installed the package for one architecture, use `make distclean' before
-reconfiguring for another architecture.
+If errors occur during the build process and you want more information on the
+build steps performed (this is particularly important if you are seeking help
+from the mailing list), perform a verbose make:
-Installation Names
-==================
+$ VERBOSE=1 make
-By default, `make install' installs the package's commands under
-`/usr/local/bin', include files under `/usr/local/include', etc. You
-can specify an installation prefix other than `/usr/local' by giving
-`configure' the option `--prefix=PREFIX'.
- You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files. If you
-pass the option `--exec-prefix=PREFIX' to `configure', the package uses
-PREFIX as the prefix for installing programs and libraries.
-Documentation and other data files still use the regular prefix.
+Configuration Options
+=====================
- In addition, if you use an unusual directory layout you can give
-options like `--bindir=DIR' to specify different values for particular
-kinds of files. Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
+General CMake options
+---------------------
- If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+CMAKE_BUILD_TYPE - Type of build to perform. Valid values are Debug, Release,
+ MinSizeRel and RelWithDebInfo.
+CMAKE_INSTALL_PREFIX - The directory to install Player into.
-Optional Features
-=================
-Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System). The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
+Player specific
+---------------
- For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
-
-There may be some features `configure' cannot figure out automatically,
-but needs to determine by the type of machine the package will run on.
-Usually, assuming the package is built to be run on the _same_
-architectures, `configure' can figure that out, but if it prints a
-message saying it cannot guess the machine type, give it the
-`--build=TYPE' option. TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name which has the form:
-
- CPU-COMPANY-SYSTEM
-
-where SYSTEM can have one of these forms:
-
- OS KERNEL-OS
-
- See the file `config.sub' for the possible values of each field. If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the machine type.
-
- If you are _building_ compiler tools for cross-compiling, you should
-use the option `--target=TYPE' to select the type of system they will
-produce code for.
-
- If you want to _use_ a cross compiler, that generates code for a
-platform different from the build platform, you should specify the
-"host" platform (i.e., that on which the generated programs will
-eventually be run) with `--host=TYPE'.
-
-Sharing Defaults
-================
-
-If you want to set default values for `configure' scripts to share, you
-can create a site shell script called `config.site' that gives default
-values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists. Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Defining Variables
-==================
-
-Variables not defined in a site shell script can be set in the
-environment passed to `configure'. However, some packages may run
-configure again during the build, and the customized values of these
-variables may be lost. In order to avoid this problem, you should set
-them in the `configure' command line, using `VAR=value'. For example:
-
- ./configure CC=/usr/local2/bin/gcc
-
-causes the specified `gcc' to be used as the C compiler (unless it is
-overridden in the site shell script).
-
-Unfortunately, this technique does not work for `CONFIG_SHELL' due to
-an Autoconf bug. Until the bug is fixed you can use this workaround:
-
- CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
-
-`configure' Invocation
-======================
-
-`configure' recognizes the following options to control how it operates.
-
-`--help'
-`-h'
- Print a summary of the options to `configure', and exit.
-
-`--version'
-`-V'
- Print the version of Autoconf used to generate the `configure'
- script, and exit.
-
-`--cache-file=FILE'
- Enable the cache: use and save the results of the tests in FILE,
- traditionally `config.cache'. FILE defaults to `/dev/null' to
- disable caching.
-
-`--config-cache'
-`-C'
- Alias for `--cache-file=config.cache'.
-
-`--quiet'
-`--silent'
-`-q'
- Do not print messages saying which checks are being made. To
- suppress all normal output, redirect it to `/dev/null' (any error
- messages will still be shown).
-
-`--srcdir=DIR'
- Look for the package's source code in directory DIR. Usually
- `configure' can determine that directory automatically.
-
-`configure' also accepts some other, not widely useful, options. Run
-`configure --help' for more details.
-
+Coming soon to an INSTALL file near you.
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by the 2008 JavaOne(SM) Conference
Don't miss this year's exciting event. There's still time to save $100.
Use priority code J8TL2D2.
http://ad.doubleclick.net/clk;198757673;13503038;p?http://java.sun.com/javaone
_______________________________________________
Playerstage-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/playerstage-commit
