Changeset 281 for trunk


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

reorganized some of the build info. refs #111

Location:
trunk
Files:
2 edited
1 copied

Legend:

Unmodified
Added
Removed
  • trunk/INSTALL

    r221 r281  
    2929Please read README for compilation prerequisites.
    3030
    31 
    3231Below you'll find the generic FSF install instructions. To compile
    3332and install svndigest you can follow the usual autoconf path:
     
    4645svndigest. You can provide './configure' with APR and subversion API
    4746location information with --with-apr=DIR and --with-svn=DIR,
    48 respectively. --enable-debug turns on debug options and code, which
    49 may be useful for developers. --enable-staticbin will create a static
     47respectively. --enable-staticbin will create a static
    5048svndigest binary. (Actually as static as the underlying program
    5149libraries allows it to be, i.e., some external libraries might not
    52 have been created/installed in static versions.) --enable-wctests will
    53 turn on subversion WC dependent test programs, only useful for
    54 developers and users that checkout the source from the subversion
    55 repository.
     50have been created/installed in static versions.)
    5651
    5752If you grabbed the source from the subversion repository you need to
  • trunk/README

    r221 r281  
    11$Id$
    22
    3 ======================================================================
    4 Copyright (C) 2005, 2006 Jari Häkkinen
     3This directory contains the 0.6 release of svndigest.
    54
    6 This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
     5svndigest is a tool to extract development information and statistics
     6from a subversion repository.
    77
    8 svndigest is free software; you can redistribute it and/or modify it
    9 under the terms of the GNU General Public License as published by the
    10 Free Software Foundation; either version 2 of the License, or (at your
    11 option) any later version.
     8See the file NEWS for the user-visible changes from previous releases.
     9In addition, there have been bugs fixed.
    1210
    13 svndigest is distributed in the hope that it will be useful, but
    14 WITHOUT ANY WARRANTY; without even the implied warranty of
    15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    16 General Public License for more details.
     11For general building and installation instructions, see the file INSTALL.
    1712
    18 You should have received a copy of the GNU General Public License
    19 along with this program; if not, write to the Free Software
    20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
    21 USA.
    22 ======================================================================
     13svndigest is free software. See the file COPYING for copying conditions.
    2314
    2415
    25 Table of contents
     16Downloading
     17-----------
    2618
    27 0  What is svndigest?
    28 1  Prerequisites
    29 2  Compilation and installation
    30 3  Running svndigest
    31 4  Acknowledgements
    32 5  Developer information
     19svndigest can be obtained from
     20
     21  http://lev.thep.lu.se/trac/svndigest
    3322
    3423
    35 0  What is svndigest?
     24Documentation
     25-------------
    3626
    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
     27For documentation see the file doc/readme.txt.
    4028
    4129
    42 1  Prerequisites
     30Development
     31-----------
     32
     33The development of svndigest can be monitored through
     34
     35  http://lev.thep.lu.se/trac/svndigest
     36
     37You can find most information concerning the development of svndigest at
     38this site.
     39
     40
     41Bug Reporting
     42-------------
     43
     44You can report svndigest bugs on
     45
     46  http://lev.thep.lu.se/trac/svndigest/newticket
     47
     48Use user `svndigest' and password `svndigest'.
     49
     50
     51Subversion Access
     52-----------------
     53
     54The svndigest source repository is available via anonymous subversion
     55from the thep subversion server; issue:
     56
     57  svn checkout http://lev.thep.lu.se/repository/svndigest/trunk svndigest
     58
     59See file README.svn for developer specific information. We make no
     60guarantees about the contents or quality of the latest code in the
     61subversion repository: it is not unheard of for code that is known to
     62be broken to checked in. Use at your own risk.
     63
     64
     65Prerequisites
     66-------------
    4367
    4468ia) Subversion development files, i.e., header files and program
     
    6387
    6488
    65 2  Compilation and installation
     89======================================================================
     90Copyright (C) 2005, 2006 Jari Häkkinen
     91Copyright (C) 2007 Peter Johansson
    6692
    67 See INSTALL for instructions on how to compile and install svndigest.
     93This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
     94
     95svndigest is free software; you can redistribute it and/or modify it
     96under the terms of the GNU General Public License as published by the
     97Free Software Foundation; either version 2 of the License, or (at your
     98option) any later version.
     99
     100svndigest is distributed in the hope that it will be useful, but
     101WITHOUT ANY WARRANTY; without even the implied warranty of
     102MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     103General Public License for more details.
     104
     105You should have received a copy of the GNU General Public License
     106along with this program; if not, write to the Free Software
     107Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
     108USA.
     109======================================================================
    68110
    69111
    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
    96 
    97 a) At first checkout from the repository, and when configure.ac is
    98 changed, you must run './bootstrap' to setup autoconf files.
    99 
    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.
    103 
    104 c) Create a distribution package with 'make dist'. Remember to test
    105 the package with 'make distcheck'. If required packages are installed
    106 in non-standard locations you need to pass this information to
    107 'distcheck'. This is done by using the variable
    108 DISTCHECK_CONFIGURE_FLAGS as
    109 
    110    DISTCHECK_CONFIGURE_FLAGS="--with-apr=/usr/loca/apr" make distcheck
    111 
    112 Usually you need to set DISTCHECK_CONFIGURE_FLAGS to whatever options
    113 you pass to configure.
  • 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.