source: trunk/README @ 264

Last change on this file since 264 was 221, checked in by Jari Häkkinen, 15 years ago

Fixes #84. Read developer information in README about how to do 'make distcheck'.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.8 KB
Line 
1$Id: README 221 2006-12-25 00:04:59Z jari $
2
3======================================================================
4Copyright (C) 2005, 2006 Jari Häkkinen
5
6This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
7
8svndigest is free software; you can redistribute it and/or modify it
9under the terms of the GNU General Public License as published by the
10Free Software Foundation; either version 2 of the License, or (at your
11option) any later version.
12
13svndigest is distributed in the hope that it will be useful, but
14WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with this program; if not, write to the Free Software
20Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
21USA.
22======================================================================
23
24
25Table of contents
26
270  What is svndigest?
281  Prerequisites
292  Compilation and installation
303  Running svndigest
314  Acknowledgements
325  Developer information
33
34
350  What is svndigest?
36
37svndigest is a tool to extract development information and statistics
38from a subversion repository. A slightly more detailed explanation is
39available in doc/readme.txt
40
41
421  Prerequisites
43
44ia) Subversion development files, i.e., header files and program
45   libraries, version 1.4 or later.
46
47ib) 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
52ii) Gnuplot.
53
54iii) 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
652  Compilation and installation
66
67See INSTALL for instructions on how to compile and install svndigest.
68
69
703  Running svndigest
71
72To get a listing of available options issue 'svndigest -h'. Simply run
73the program with
74
75   svndigest -r /path/to/a/subversion/WC -t /path/whereto/write/output -v
76
77The -v option will produce some output to stdout and can be omitted.
78
79
804  Acknowledgements
81
82svndigest uses a C++ interface to Gnuplot inspired by Rajarshi Guha.
83
84Rajarshi Guha's "A C++ Interface to Gnuplot" can be found through
85http://jijo.cjb.net/ . The C++ interface is based on "gnuplot
86interfaces in ANSI C" written by Nicolas Devillard. The C implemention
87is available through http://ndevilla.free.fr/ .
88
89svndigest build system uses an M4 macro (build_support/find_apr.m4)
90created within the Apache project (The Apache Software Foundation). No
91changes is made to the M4 script. The apache license text is available
92as buid_support/apache_LICENSE-2.0.txt.
93
94
955  Developer information
96
97a) At first checkout from the repository, and when configure.ac is
98changed, you must run './bootstrap' to setup autoconf files.
99
100b) All tests are not enabled by default since some of the testes
101depends on being run from a subversion WC. Add '--enable-wctests' to
102configure to enable WC depedent tests.
103
104c) Create a distribution package with 'make dist'. Remember to test
105the package with 'make distcheck'. If required packages are installed
106in non-standard locations you need to pass this information to
107'distcheck'. This is done by using the variable
108DISTCHECK_CONFIGURE_FLAGS as
109
110   DISTCHECK_CONFIGURE_FLAGS="--with-apr=/usr/loca/apr" make distcheck
111
112Usually you need to set DISTCHECK_CONFIGURE_FLAGS to whatever options
113you pass to configure.
Note: See TracBrowser for help on using the repository browser.