1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/toolkit/crashreporter/google-breakpad/src/third_party/glog/INSTALL Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,297 @@
1.4 +Installation Instructions
1.5 +*************************
1.6 +
1.7 +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
1.8 +2006, 2007 Free Software Foundation, Inc.
1.9 +
1.10 +This file is free documentation; the Free Software Foundation gives
1.11 +unlimited permission to copy, distribute and modify it.
1.12 +
1.13 +Glog-Specific Install Notes
1.14 +================================
1.15 +
1.16 +*** NOTE FOR 64-BIT LINUX SYSTEMS
1.17 +
1.18 +The glibc built-in stack-unwinder on 64-bit systems has some problems
1.19 +with the glog libraries. (In particular, if you are using
1.20 +InstallFailureSignalHandler(), the signal may be raised in the middle
1.21 +of malloc, holding some malloc-related locks when they invoke the
1.22 +stack unwinder. The built-in stack unwinder may call malloc
1.23 +recursively, which may require the thread to acquire a lock it already
1.24 +holds: deadlock.)
1.25 +
1.26 +For that reason, if you use a 64-bit system and you need
1.27 +InstallFailureSignalHandler(), we strongly recommend you install
1.28 +libunwind before trying to configure or install google glog.
1.29 +libunwind can be found at
1.30 +
1.31 + http://download.savannah.nongnu.org/releases/libunwind/libunwind-snap-070410.tar.gz
1.32 +
1.33 +Even if you already have libunwind installed, you will probably still
1.34 +need to install from the snapshot to get the latest version.
1.35 +
1.36 +CAUTION: if you install libunwind from the URL above, be aware that
1.37 +you may have trouble if you try to statically link your binary with
1.38 +glog: that is, if you link with 'gcc -static -lgcc_eh ...'. This
1.39 +is because both libunwind and libgcc implement the same C++ exception
1.40 +handling APIs, but they implement them differently on some platforms.
1.41 +This is not likely to be a problem on ia64, but may be on x86-64.
1.42 +
1.43 +Also, if you link binaries statically, make sure that you add
1.44 +-Wl,--eh-frame-hdr to your linker options. This is required so that
1.45 +libunwind can find the information generated by the compiler required
1.46 +for stack unwinding.
1.47 +
1.48 +Using -static is rare, though, so unless you know this will affect you
1.49 +it probably won't.
1.50 +
1.51 +If you cannot or do not wish to install libunwind, you can still try
1.52 +to use two kinds of stack-unwinder: 1. glibc built-in stack-unwinder
1.53 +and 2. frame pointer based stack-unwinder.
1.54 +
1.55 +1. As we already mentioned, glibc's unwinder has a deadlock issue.
1.56 +However, if you don't use InstallFailureSignalHandler() or you don't
1.57 +worry about the rare possibilities of deadlocks, you can use this
1.58 +stack-unwinder. If you specify no options and libunwind isn't
1.59 +detected on your system, the configure script chooses this unwinder by
1.60 +default.
1.61 +
1.62 +2. The frame pointer based stack unwinder requires that your
1.63 +application, the glog library, and system libraries like libc, all be
1.64 +compiled with a frame pointer. This is *not* the default for x86-64.
1.65 +
1.66 +If you are on x86-64 system, know that you have a set of system
1.67 +libraries with frame-pointers enabled, and compile all your
1.68 +applications with -fno-omit-frame-pointer, then you can enable the
1.69 +frame pointer based stack unwinder by passing the
1.70 +--enable-frame-pointers flag to configure.
1.71 +
1.72 +
1.73 +Basic Installation
1.74 +==================
1.75 +
1.76 +Briefly, the shell commands `./configure; make; make install' should
1.77 +configure, build, and install this package. The following
1.78 +more-detailed instructions are generic; see the `README' file for
1.79 +instructions specific to this package.
1.80 +
1.81 + The `configure' shell script attempts to guess correct values for
1.82 +various system-dependent variables used during compilation. It uses
1.83 +those values to create a `Makefile' in each directory of the package.
1.84 +It may also create one or more `.h' files containing system-dependent
1.85 +definitions. Finally, it creates a shell script `config.status' that
1.86 +you can run in the future to recreate the current configuration, and a
1.87 +file `config.log' containing compiler output (useful mainly for
1.88 +debugging `configure').
1.89 +
1.90 + It can also use an optional file (typically called `config.cache'
1.91 +and enabled with `--cache-file=config.cache' or simply `-C') that saves
1.92 +the results of its tests to speed up reconfiguring. Caching is
1.93 +disabled by default to prevent problems with accidental use of stale
1.94 +cache files.
1.95 +
1.96 + If you need to do unusual things to compile the package, please try
1.97 +to figure out how `configure' could check whether to do them, and mail
1.98 +diffs or instructions to the address given in the `README' so they can
1.99 +be considered for the next release. If you are using the cache, and at
1.100 +some point `config.cache' contains results you don't want to keep, you
1.101 +may remove or edit it.
1.102 +
1.103 + The file `configure.ac' (or `configure.in') is used to create
1.104 +`configure' by a program called `autoconf'. You need `configure.ac' if
1.105 +you want to change it or regenerate `configure' using a newer version
1.106 +of `autoconf'.
1.107 +
1.108 +The simplest way to compile this package is:
1.109 +
1.110 + 1. `cd' to the directory containing the package's source code and type
1.111 + `./configure' to configure the package for your system.
1.112 +
1.113 + Running `configure' might take a while. While running, it prints
1.114 + some messages telling which features it is checking for.
1.115 +
1.116 + 2. Type `make' to compile the package.
1.117 +
1.118 + 3. Optionally, type `make check' to run any self-tests that come with
1.119 + the package.
1.120 +
1.121 + 4. Type `make install' to install the programs and any data files and
1.122 + documentation.
1.123 +
1.124 + 5. You can remove the program binaries and object files from the
1.125 + source code directory by typing `make clean'. To also remove the
1.126 + files that `configure' created (so you can compile the package for
1.127 + a different kind of computer), type `make distclean'. There is
1.128 + also a `make maintainer-clean' target, but that is intended mainly
1.129 + for the package's developers. If you use it, you may have to get
1.130 + all sorts of other programs in order to regenerate files that came
1.131 + with the distribution.
1.132 +
1.133 + 6. Often, you can also type `make uninstall' to remove the installed
1.134 + files again.
1.135 +
1.136 +Compilers and Options
1.137 +=====================
1.138 +
1.139 +Some systems require unusual options for compilation or linking that the
1.140 +`configure' script does not know about. Run `./configure --help' for
1.141 +details on some of the pertinent environment variables.
1.142 +
1.143 + You can give `configure' initial values for configuration parameters
1.144 +by setting variables in the command line or in the environment. Here
1.145 +is an example:
1.146 +
1.147 + ./configure CC=c99 CFLAGS=-g LIBS=-lposix
1.148 +
1.149 + *Note Defining Variables::, for more details.
1.150 +
1.151 +Compiling For Multiple Architectures
1.152 +====================================
1.153 +
1.154 +You can compile the package for more than one kind of computer at the
1.155 +same time, by placing the object files for each architecture in their
1.156 +own directory. To do this, you can use GNU `make'. `cd' to the
1.157 +directory where you want the object files and executables to go and run
1.158 +the `configure' script. `configure' automatically checks for the
1.159 +source code in the directory that `configure' is in and in `..'.
1.160 +
1.161 + With a non-GNU `make', it is safer to compile the package for one
1.162 +architecture at a time in the source code directory. After you have
1.163 +installed the package for one architecture, use `make distclean' before
1.164 +reconfiguring for another architecture.
1.165 +
1.166 +Installation Names
1.167 +==================
1.168 +
1.169 +By default, `make install' installs the package's commands under
1.170 +`/usr/local/bin', include files under `/usr/local/include', etc. You
1.171 +can specify an installation prefix other than `/usr/local' by giving
1.172 +`configure' the option `--prefix=PREFIX'.
1.173 +
1.174 + You can specify separate installation prefixes for
1.175 +architecture-specific files and architecture-independent files. If you
1.176 +pass the option `--exec-prefix=PREFIX' to `configure', the package uses
1.177 +PREFIX as the prefix for installing programs and libraries.
1.178 +Documentation and other data files still use the regular prefix.
1.179 +
1.180 + In addition, if you use an unusual directory layout you can give
1.181 +options like `--bindir=DIR' to specify different values for particular
1.182 +kinds of files. Run `configure --help' for a list of the directories
1.183 +you can set and what kinds of files go in them.
1.184 +
1.185 + If the package supports it, you can cause programs to be installed
1.186 +with an extra prefix or suffix on their names by giving `configure' the
1.187 +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
1.188 +
1.189 +Optional Features
1.190 +=================
1.191 +
1.192 +Some packages pay attention to `--enable-FEATURE' options to
1.193 +`configure', where FEATURE indicates an optional part of the package.
1.194 +They may also pay attention to `--with-PACKAGE' options, where PACKAGE
1.195 +is something like `gnu-as' or `x' (for the X Window System). The
1.196 +`README' should mention any `--enable-' and `--with-' options that the
1.197 +package recognizes.
1.198 +
1.199 + For packages that use the X Window System, `configure' can usually
1.200 +find the X include and library files automatically, but if it doesn't,
1.201 +you can use the `configure' options `--x-includes=DIR' and
1.202 +`--x-libraries=DIR' to specify their locations.
1.203 +
1.204 +Specifying the System Type
1.205 +==========================
1.206 +
1.207 +There may be some features `configure' cannot figure out automatically,
1.208 +but needs to determine by the type of machine the package will run on.
1.209 +Usually, assuming the package is built to be run on the _same_
1.210 +architectures, `configure' can figure that out, but if it prints a
1.211 +message saying it cannot guess the machine type, give it the
1.212 +`--build=TYPE' option. TYPE can either be a short name for the system
1.213 +type, such as `sun4', or a canonical name which has the form:
1.214 +
1.215 + CPU-COMPANY-SYSTEM
1.216 +
1.217 +where SYSTEM can have one of these forms:
1.218 +
1.219 + OS KERNEL-OS
1.220 +
1.221 + See the file `config.sub' for the possible values of each field. If
1.222 +`config.sub' isn't included in this package, then this package doesn't
1.223 +need to know the machine type.
1.224 +
1.225 + If you are _building_ compiler tools for cross-compiling, you should
1.226 +use the option `--target=TYPE' to select the type of system they will
1.227 +produce code for.
1.228 +
1.229 + If you want to _use_ a cross compiler, that generates code for a
1.230 +platform different from the build platform, you should specify the
1.231 +"host" platform (i.e., that on which the generated programs will
1.232 +eventually be run) with `--host=TYPE'.
1.233 +
1.234 +Sharing Defaults
1.235 +================
1.236 +
1.237 +If you want to set default values for `configure' scripts to share, you
1.238 +can create a site shell script called `config.site' that gives default
1.239 +values for variables like `CC', `cache_file', and `prefix'.
1.240 +`configure' looks for `PREFIX/share/config.site' if it exists, then
1.241 +`PREFIX/etc/config.site' if it exists. Or, you can set the
1.242 +`CONFIG_SITE' environment variable to the location of the site script.
1.243 +A warning: not all `configure' scripts look for a site script.
1.244 +
1.245 +Defining Variables
1.246 +==================
1.247 +
1.248 +Variables not defined in a site shell script can be set in the
1.249 +environment passed to `configure'. However, some packages may run
1.250 +configure again during the build, and the customized values of these
1.251 +variables may be lost. In order to avoid this problem, you should set
1.252 +them in the `configure' command line, using `VAR=value'. For example:
1.253 +
1.254 + ./configure CC=/usr/local2/bin/gcc
1.255 +
1.256 +causes the specified `gcc' to be used as the C compiler (unless it is
1.257 +overridden in the site shell script).
1.258 +
1.259 +Unfortunately, this technique does not work for `CONFIG_SHELL' due to
1.260 +an Autoconf bug. Until the bug is fixed you can use this workaround:
1.261 +
1.262 + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
1.263 +
1.264 +`configure' Invocation
1.265 +======================
1.266 +
1.267 +`configure' recognizes the following options to control how it operates.
1.268 +
1.269 +`--help'
1.270 +`-h'
1.271 + Print a summary of the options to `configure', and exit.
1.272 +
1.273 +`--version'
1.274 +`-V'
1.275 + Print the version of Autoconf used to generate the `configure'
1.276 + script, and exit.
1.277 +
1.278 +`--cache-file=FILE'
1.279 + Enable the cache: use and save the results of the tests in FILE,
1.280 + traditionally `config.cache'. FILE defaults to `/dev/null' to
1.281 + disable caching.
1.282 +
1.283 +`--config-cache'
1.284 +`-C'
1.285 + Alias for `--cache-file=config.cache'.
1.286 +
1.287 +`--quiet'
1.288 +`--silent'
1.289 +`-q'
1.290 + Do not print messages saying which checks are being made. To
1.291 + suppress all normal output, redirect it to `/dev/null' (any error
1.292 + messages will still be shown).
1.293 +
1.294 +`--srcdir=DIR'
1.295 + Look for the package's source code in directory DIR. Usually
1.296 + `configure' can determine that directory automatically.
1.297 +
1.298 +`configure' also accepts some other, not widely useful, options. Run
1.299 +`configure --help' for more details.
1.300 +
