Changeset 281 for trunk/README.svn


Ignore:
Timestamp:
May 6, 2007, 1:54:58 PM (14 years ago)
Author:
Peter Johansson
Message:

reorganized some of the build info. refs #111

File:
1 copied

Legend:

Unmodified
Added
Removed
  • trunk/README.svn

    r278 r281  
    22
    33======================================================================
    4 Copyright (C) 2005, 2006 Jari Häkkinen
     4Copyright (C) 2006 Jari Häkkinen
     5Copyright (C) 2007 Peter Johansson
    56
    67This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
     
    2324
    2425
    25 Table of contents
    26 
    27 0  What is svndigest?
    28 1  Prerequisites
    29 2  Compilation and installation
    30 3  Running svndigest
    31 4  Acknowledgements
    32 5  Developer information
    33 
    34 
    35 0  What is svndigest?
    36 
    37 svndigest is a tool to extract development information and statistics
    38 from a subversion repository. A slightly more detailed explanation is
    39 available in doc/readme.txt
    40 
    41 
    42 1  Prerequisites
    43 
    44 ia) Subversion development files, i.e., header files and program
    45    libraries, version 1.4 or later.
    46 
    47 ib) This item should not be an issue if item ia) is fulfilled; the
    48    Apache Portable Runtime (APR) should be available if the subversion
    49    API was succesfully compiled. Subversion depends on APR and in
    50    consequence, the dependency is inherited by svndigest.
    51 
    52 ii) Gnuplot.
    53 
    54 iii) A standard C++ compliant compiler with one extension: svndigest
    55    must be compiled with a C++ compiler that supports 'long long'
    56    types - GCC does this. This is due to the fact that one of the
    57    underlying libraries, APR, is using 'long long'. APR is written in
    58    C and the C standard allows 'long long'.
    59 
    60    Even though the source is compiled with the -pedantic flag (which
    61    should catch the non C++ standard 'long long') there is another
    62    flag to suppress 'long long' diagnostics, -Wno-long-long.
    63 
    64 
    65 2  Compilation and installation
    66 
    67 See INSTALL for instructions on how to compile and install svndigest.
    68 
    69 
    70 3  Running svndigest
    71 
    72 To get a listing of available options issue 'svndigest -h'. Simply run
    73 the program with
    74 
    75    svndigest -r /path/to/a/subversion/WC -t /path/whereto/write/output -v
    76 
    77 The -v option will produce some output to stdout and can be omitted.
    78 
    79 
    80 4  Acknowledgements
    81 
    82 svndigest uses a C++ interface to Gnuplot inspired by Rajarshi Guha.
    83 
    84 Rajarshi Guha's "A C++ Interface to Gnuplot" can be found through
    85 http://jijo.cjb.net/ . The C++ interface is based on "gnuplot
    86 interfaces in ANSI C" written by Nicolas Devillard. The C implemention
    87 is available through http://ndevilla.free.fr/ .
    88 
    89 svndigest build system uses an M4 macro (build_support/find_apr.m4)
    90 created within the Apache project (The Apache Software Foundation). No
    91 changes is made to the M4 script. The apache license text is available
    92 as buid_support/apache_LICENSE-2.0.txt.
    93 
    94 
    95 5  Developer information
     26This file contains developer specific information.
    9627
    9728a) At first checkout from the repository, and when configure.ac is
    9829changed, you must run './bootstrap' to setup autoconf files.
    9930
    100 b) All tests are not enabled by default since some of the testes
    101 depends on being run from a subversion WC. Add '--enable-wctests' to
    102 configure to enable WC depedent tests.
     31b) Run generated configure script with
     32
     33  './configure --enable-debug --enable-wctests'
     34
     35The option flag '--enable-debug' turns on debug options (e.g. enables
     36assertions). The option flag '--enable-wctests' turns on some
     37additional tests. All tests are not enabled by default since some of
     38the tests depend on being run from a subversion WC.
    10339
    10440c) Create a distribution package with 'make dist'. Remember to test
     
    11147
    11248Usually you need to set DISTCHECK_CONFIGURE_FLAGS to whatever options
    113 you pass to configure.
     49you pass to configure with the exception of '--enable-wctests'.
     50Passing '--enable-wctests' to distcheck will always fail because a
     51distribution misses some files needed for WC tests.
Note: See TracChangeset for help on using the changeset viewer.