Changeset 340


Ignore:
Timestamp:
May 19, 2007, 12:45:00 PM (14 years ago)
Author:
Peter Johansson
Message:

moving requirements from README to INSTALL. Also made INSTALL text/x-trac-wiki and modified the text to look good in the browser. Refs #111

Location:
trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/INSTALL

    • Property svn:mime-type set to text/x-trac-wiki
    r281 r340  
    11$Id$
    2 
    3 ======================================================================
     2{{{
    43Copyright (C) 2006 Jari Häkkinen
    5 
    6 Files are copyright by their respective authors. The contributions to
    7 files where copyright is not explicitly stated can be traced with the
    8 source code revision system.
     4Copyright (C) 2007 Peter Johansson
    95
    106This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
     
    2420Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
    2521USA.
    26 ======================================================================
    27 
    28 
    29 Please read README for compilation prerequisites.
     22}}}
     23----------------------------------------------------------------------
     24
     25= Svndigest Installation Guide =
     26
     27Svndigest is a tool to exctract development information and statistics
     28from a subversion repository. Svndigest is written in C++ and extracts
     29repository history using the subversion API. The resulting report is
     30written to a user specifiable directory in HTML format.
     31
     32== Requirements ==
     33
     34 * Subversion development files, i.e., header files and program
     35   libraries, version 1.4 or later.
     36
     37 * This item should not be an issue if item above is fulfilled; the
     38   Apache Portable Runtime (APR) should be available if the subversion
     39   API was succesfully compiled. Subversion depends on APR and in
     40   consequence, the dependency is inherited by svndigest.
     41
     42 * Gnuplot.
     43
     44 * A standard C++ compliant compiler with one extension: svndigest
     45   must be compiled with a C++ compiler that supports 'long long'
     46   types - GCC does this. This is due to the fact that one of the
     47   underlying libraries, APR, is using 'long long'. APR is written in
     48   C and the C standard allows 'long long'.
     49   Even though the source is compiled with the -pedantic flag (which
     50   should catch the non C++ standard 'long long') there is another
     51   flag to suppress 'long long' diagnostics, -Wno-long-long.
     52
     53== Installing svndigest ==
    3054
    3155Below you'll find the generic FSF install instructions. To compile
    3256and install svndigest you can follow the usual autoconf path:
    3357
    34 # ./configure
    35 # make
    36 # make install
    37 
    38 With an optional
    39 
    40 # make check
    41 
    42 to run test programs. All test programs are not enabled by default.
    43 
    44 The './configure' script accepts a few options of interest for
    45 svndigest. You can provide './configure' with APR and subversion API
    46 location information with --with-apr=DIR and --with-svn=DIR,
    47 respectively. --enable-staticbin will create a static
     58 * `./configure`
     59
     60 * `make`
     61
     62 * Optionally, `make check` to run test programs. All test programs are not enabled by default.
     63
     64 * `make install`
     65
     66The `./configure` script accepts a few options of interest for
     67svndigest. You can provide `./configure` with APR and subversion API
     68location information with `--with-apr=DIR` and `--with-svn=DIR`,
     69respectively. `--enable-staticbin` will create a static
    4870svndigest binary. (Actually as static as the underlying program
    4971libraries allows it to be, i.e., some external libraries might not
     
    5173
    5274If you grabbed the source from the subversion repository you need to
    53 run './bootstrap' to setup autoconf files.
    54 
    55 
    56 FSF generic install documentation:
    57 
    58 Installation Instructions
    59 *************************
     75run `./bootstrap` to setup autoconf files (see README.svn).
     76
     77
     78== FSF generic install documentation ==
    6079
    6180Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004 Free
     
    6584unlimited permission to copy, distribute and modify it.
    6685
    67 Basic Installation
    68 ==================
     86=== Basic Installation ===
    6987
    7088These are generic installation instructions.
    7189
    72    The `configure' shell script attempts to guess correct values for
     90The `configure` shell script attempts to guess correct values for
    7391various system-dependent variables used during compilation.  It uses
    74 those values to create a `Makefile' in each directory of the package.
    75 It may also create one or more `.h' files containing system-dependent
    76 definitions.  Finally, it creates a shell script `config.status' that
     92those values to create a `Makefile` in each directory of the package.
     93It may also create one or more `.h` files containing system-dependent
     94definitions.  Finally, it creates a shell script `config.status` that
    7795you can run in the future to recreate the current configuration, and a
    78 file `config.log' containing compiler output (useful mainly for
    79 debugging `configure').
    80 
    81    It can also use an optional file (typically called `config.cache'
    82 and enabled with `--cache-file=config.cache' or simply `-C') that saves
     96file `config.log` containing compiler output (useful mainly for
     97debugging `configure`).
     98
     99It can also use an optional file (typically called `config.cache`
     100and enabled with `--cache-file=config.cache` or simply `-C`) that saves
    83101the results of its tests to speed up reconfiguring.  (Caching is
    84102disabled by default to prevent problems with accidental use of stale
    85103cache files.)
    86104
    87    If you need to do unusual things to compile the package, please try
    88 to figure out how `configure' could check whether to do them, and mail
    89 diffs or instructions to the address given in the `README' so they can
     105If you need to do unusual things to compile the package, please try
     106to figure out how `configure` could check whether to do them, and mail
     107diffs or instructions to the address given in the `README` so they can
    90108be considered for the next release.  If you are using the cache, and at
    91 some point `config.cache' contains results you don't want to keep, you
     109some point `config.cache` contains results you don't want to keep, you
    92110may remove or edit it.
    93111
    94    The file `configure.ac' (or `configure.in') is used to create
    95 `configure' by a program called `autoconf'.  You only need
    96 `configure.ac' if you want to change it or regenerate `configure' using
    97 a newer version of `autoconf'.
     112The file `configure.ac` (or `configure.in`) is used to create
     113`configure` by a program called `autoconf`.  You only need
     114`configure.ac` if you want to change it or regenerate `configure` using
     115a newer version of `autoconf`.
    98116
    99117The simplest way to compile this package is:
    100118
    101   1. `cd' to the directory containing the package's source code and type
    102      `./configure' to configure the package for your system.  If you're
    103      using `csh' on an old version of System V, you might need to type
    104      `sh ./configure' instead to prevent `csh' from trying to execute
    105      `configure' itself.
    106 
    107      Running `configure' takes awhile.  While running, it prints some
     119   * `cd` to the directory containing the package's source code and type
     120     `./configure` to configure the package for your system.  If you're
     121     using `csh` on an old version of System V, you might need to type
     122     `sh ./configure` instead to prevent `csh` from trying to execute
     123     `configure` itself.
     124
     125     Running `configure` takes awhile.  While running, it prints some
    108126     messages telling which features it is checking for.
    109127
    110   2. Type `make' to compile the package.
    111 
    112   3. Optionally, type `make check' to run any self-tests that come with
     128   * Type `make` to compile the package.
     129
     130   * Optionally, type `make check` to run any self-tests that come with
    113131     the package.
    114132
    115   4. Type `make install' to install the programs and any data files and
     133   * Type `make install` to install the programs and any data files and
    116134     documentation.
    117135
    118   5. You can remove the program binaries and object files from the
    119      source code directory by typing `make clean'.  To also remove the
    120      files that `configure' created (so you can compile the package for
    121      a different kind of computer), type `make distclean'.  There is
    122      also a `make maintainer-clean' target, but that is intended mainly
     136   * You can remove the program binaries and object files from the
     137     source code directory by typing `make clean`.  To also remove the
     138     files that `configure` created (so you can compile the package for
     139     a different kind of computer), type `make distclean`.  There is
     140     also a `make maintainer-clean` target, but that is intended mainly
    123141     for the package's developers.  If you use it, you may have to get
    124142     all sorts of other programs in order to regenerate files that came
    125143     with the distribution.
    126144
    127 Compilers and Options
    128 =====================
     145=== Compilers and Options ===
    129146
    130147Some systems require unusual options for compilation or linking that the
    131 `configure' script does not know about.  Run `./configure --help' for
     148`configure` script does not know about.  Run `./configure --help` for
    132149details on some of the pertinent environment variables.
    133150
    134    You can give `configure' initial values for configuration parameters
     151You can give `configure` initial values for configuration parameters
    135152by setting variables in the command line or in the environment.  Here
    136153is an example:
    137154
    138      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
     155     `./configure CC=c89 CFLAGS=-O2 LIBS=-lposix`
    139156
    140157   *Note Defining Variables::, for more details.
    141158
    142 Compiling For Multiple Architectures
    143 ====================================
     159=== Compiling For Multiple Architectures ===
    144160
    145161You can compile the package for more than one kind of computer at the
    146162same time, by placing the object files for each architecture in their
    147 own directory.  To do this, you must use a version of `make' that
    148 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
     163own directory.  To do this, you must use a version of `make` that
     164supports the `VPATH` variable, such as GNU `make`.  `cd` to the
    149165directory where you want the object files and executables to go and run
    150 the `configure' script.  `configure' automatically checks for the
    151 source code in the directory that `configure' is in and in `..'.
    152 
    153    If you have to use a `make' that does not support the `VPATH'
     166the `configure` script.  `configure` automatically checks for the
     167source code in the directory that `configure` is in and in `..`.
     168
     169If you have to use a `make` that does not support the `VPATH`
    154170variable, you have to compile the package for one architecture at a
    155171time in the source code directory.  After you have installed the
    156 package for one architecture, use `make distclean' before reconfiguring
     172package for one architecture, use `make distclean` before reconfiguring
    157173for another architecture.
    158174
    159 Installation Names
    160 ==================
    161 
    162 By default, `make install' will install the package's files in
    163 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
    164 installation prefix other than `/usr/local' by giving `configure' the
    165 option `--prefix=PREFIX'.
    166 
    167    You can specify separate installation prefixes for
     175=== Installation Names ===
     176
     177By default, `make install` will install the package's files in
     178`/usr/local/bin`, `/usr/local/man`, etc.  You can specify an
     179installation prefix other than `/usr/local` by giving `configure` the
     180option `--prefix=PREFIX`.
     181
     182You can specify separate installation prefixes for
    168183architecture-specific files and architecture-independent files.  If you
    169 give `configure' the option `--exec-prefix=PREFIX', the package will
     184give `configure` the option `--exec-prefix=PREFIX`, the package will
    170185use PREFIX as the prefix for installing programs and libraries.
    171186Documentation and other data files will still use the regular prefix.
    172187
    173    In addition, if you use an unusual directory layout you can give
    174 options like `--bindir=DIR' to specify different values for particular
    175 kinds of files.  Run `configure --help' for a list of the directories
     188In addition, if you use an unusual directory layout you can give
     189options like `--bindir=DIR` to specify different values for particular
     190kinds of files.  Run `configure --help` for a list of the directories
    176191you can set and what kinds of files go in them.
    177192
    178    If the package supports it, you can cause programs to be installed
    179 with an extra prefix or suffix on their names by giving `configure' the
    180 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
    181 
    182 Optional Features
    183 =================
    184 
    185 Some packages pay attention to `--enable-FEATURE' options to
    186 `configure', where FEATURE indicates an optional part of the package.
    187 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
    188 is something like `gnu-as' or `x' (for the X Window System).  The
    189 `README' should mention any `--enable-' and `--with-' options that the
     193If the package supports it, you can cause programs to be installed
     194with an extra prefix or suffix on their names by giving `configure` the
     195option `--program-prefix=PREFIX` or `--program-suffix=SUFFIX`.
     196
     197=== Optional Features ===
     198
     199Some packages pay attention to `--enable-FEATURE` options to
     200`configure`, where FEATURE indicates an optional part of the package.
     201They may also pay attention to `--with-PACKAGE` options, where PACKAGE
     202is something like `gnu-as` or `x` (for the X Window System).  The
     203`README` should mention any `--enable-` and `--with-` options that the
    190204package recognizes.
    191205
    192    For packages that use the X Window System, `configure' can usually
     206For packages that use the X Window System, `configure` can usually
    193207find the X include and library files automatically, but if it doesn't,
    194 you can use the `configure' options `--x-includes=DIR' and
    195 `--x-libraries=DIR' to specify their locations.
    196 
    197 Specifying the System Type
    198 ==========================
    199 
    200 There may be some features `configure' cannot figure out automatically,
     208you can use the `configure` options `--x-includes=DIR` and
     209`--x-libraries=DIR` to specify their locations.
     210
     211=== Specifying the System Type ===
     212
     213There may be some features `configure` cannot figure out automatically,
    201214but needs to determine by the type of machine the package will run on.
    202215Usually, assuming the package is built to be run on the _same_
    203 architectures, `configure' can figure that out, but if it prints a
     216architectures, `configure` can figure that out, but if it prints a
    204217message saying it cannot guess the machine type, give it the
    205 `--build=TYPE' option.  TYPE can either be a short name for the system
    206 type, such as `sun4', or a canonical name which has the form:
     218`--build=TYPE` option.  TYPE can either be a short name for the system
     219type, such as `sun4`, or a canonical name which has the form:
    207220
    208221     CPU-COMPANY-SYSTEM
     
    212225     OS KERNEL-OS
    213226
    214    See the file `config.sub' for the possible values of each field.  If
    215 `config.sub' isn't included in this package, then this package doesn't
     227See the file `config.sub` for the possible values of each field.  If
     228`config.sub` isn't included in this package, then this package doesn't
    216229need to know the machine type.
    217230
    218    If you are _building_ compiler tools for cross-compiling, you should
    219 use the `--target=TYPE' option to select the type of system they will
     231If you are _building_ compiler tools for cross-compiling, you should
     232use the `--target=TYPE` option to select the type of system they will
    220233produce code for.
    221234
    222    If you want to _use_ a cross compiler, that generates code for a
     235If you want to _use_ a cross compiler, that generates code for a
    223236platform different from the build platform, you should specify the
    224237"host" platform (i.e., that on which the generated programs will
    225 eventually be run) with `--host=TYPE'.
    226 
    227 Sharing Defaults
    228 ================
    229 
    230 If you want to set default values for `configure' scripts to share, you
    231 can create a site shell script called `config.site' that gives default
    232 values for variables like `CC', `cache_file', and `prefix'.
    233 `configure' looks for `PREFIX/share/config.site' if it exists, then
    234 `PREFIX/etc/config.site' if it exists.  Or, you can set the
    235 `CONFIG_SITE' environment variable to the location of the site script.
    236 A warning: not all `configure' scripts look for a site script.
    237 
    238 Defining Variables
    239 ==================
     238eventually be run) with `--host=TYPE`.
     239
     240=== Sharing Defaults ===
     241
     242If you want to set default values for `configure` scripts to share, you
     243can create a site shell script called `config.site` that gives default
     244values for variables like `CC`, `cache_file`, and `prefix`.
     245`configure` looks for `PREFIX/share/config.site` if it exists, then
     246`PREFIX/etc/config.site` if it exists.  Or, you can set the
     247`CONFIG_SITE` environment variable to the location of the site script.
     248A warning: not all `configure` scripts look for a site script.
     249
     250=== Defining Variables ===
    240251
    241252Variables not defined in a site shell script can be set in the
    242 environment passed to `configure'.  However, some packages may run
     253environment passed to `configure`.  However, some packages may run
    243254configure again during the build, and the customized values of these
    244255variables may be lost.  In order to avoid this problem, you should set
    245 them in the `configure' command line, using `VAR=value'.  For example:
     256them in the `configure` command line, using `VAR=value`.  For example:
    246257
    247258     ./configure CC=/usr/local2/bin/gcc
     
    250261overridden in the site shell script).
    251262
    252 `configure' Invocation
    253 ======================
    254 
    255 `configure' recognizes the following options to control how it operates.
    256 
    257 `--help'
    258 `-h'
    259      Print a summary of the options to `configure', and exit.
    260 
    261 `--version'
    262 `-V'
    263      Print the version of Autoconf used to generate the `configure'
     263=== `configure` Invocation ===
     264
     265`configure` recognizes the following options to control how it operates.
     266
     267`--help`
     268`-h`
     269     Print a summary of the options to `configure`, and exit.
     270
     271`--version`
     272`-V`
     273     Print the version of Autoconf used to generate the `configure`
    264274     script, and exit.
    265275
    266 `--cache-file=FILE'
     276`--cache-file=FILE`
    267277     Enable the cache: use and save the results of the tests in FILE,
    268      traditionally `config.cache'.  FILE defaults to `/dev/null' to
     278     traditionally `config.cache`.  FILE defaults to `/dev/null` to
    269279     disable caching.
    270280
    271 `--config-cache'
    272 `-C'
    273      Alias for `--cache-file=config.cache'.
    274 
    275 `--quiet'
    276 `--silent'
    277 `-q'
     281`--config-cache`
     282`-C`
     283     Alias for `--cache-file=config.cache`.
     284
     285`--quiet`
     286`--silent`
     287`-q`
    278288     Do not print messages saying which checks are being made.  To
    279      suppress all normal output, redirect it to `/dev/null' (any error
     289     suppress all normal output, redirect it to `/dev/null` (any error
    280290     messages will still be shown).
    281291
    282 `--srcdir=DIR'
     292`--srcdir=DIR`
    283293     Look for the package's source code in directory DIR.  Usually
    284      `configure' can determine that directory automatically.
    285 
    286 `configure' also accepts some other, not widely useful, options.  Run
    287 `configure --help' for more details.
    288 
     294     `configure` can determine that directory automatically.
     295
     296`configure` also accepts some other, not widely useful, options.  Run
     297`configure --help` for more details.
     298
  • trunk/README

    r337 r340  
    6060
    6161
    62 == Prerequisites ==
    63 
    64 ia) Subversion development files, i.e., header files and program
    65    libraries, version 1.4 or later.
    66 
    67 ib) This item should not be an issue if item ia) is fulfilled; the
    68    Apache Portable Runtime (APR) should be available if the subversion
    69    API was succesfully compiled. Subversion depends on APR and in
    70    consequence, the dependency is inherited by svndigest.
    71 
    72 ii) Gnuplot.
    73 
    74 iii) A standard C++ compliant compiler with one extension: svndigest
    75    must be compiled with a C++ compiler that supports 'long long'
    76    types - GCC does this. This is due to the fact that one of the
    77    underlying libraries, APR, is using 'long long'. APR is written in
    78    C and the C standard allows 'long long'.
    79 
    80    Even though the source is compiled with the -pedantic flag (which
    81    should catch the non C++ standard 'long long') there is another
    82    flag to suppress 'long long' diagnostics, -Wno-long-long.
    83 
    84 
    8562----------------------------------------------------------------------
    8663{{{
Note: See TracChangeset for help on using the changeset viewer.