source: trunk/README.developer @ 730

Last change on this file since 730 was 724, checked in by Peter Johansson, 13 years ago
  • README.developer: adding text on Requirements for building from svn checkout
  • configure.ac: support for help2man and new man/Makefile
  • lib/OptionVersion.cc lib/OptionVersion.h bin/Parameter.cc: changed --version output so when used in combination with --no-verbose it is compliant with help2man
  • lib/utility.cc: removed function version_string not used anymore

closes #361

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-trac-wiki
File size: 5.7 KB
RevLine 
[84]1$Id: README.developer 724 2008-12-09 13:34:16Z peter $
[26]2
[338]3= Developer Information =
4
5This file contains developer specific information.
6
[394]7
8=== Coding style ===
9
10Developers should follow the coding style outlined in the
[560]11[http://cbbp.thep.lu.se/~jari/documents/c++_coding_guidelines/index.html C++ coding guidelines].
[394]12
13
14=== Subversion usage ===
15
16Commits should be minimalistic and the projects should always compile
[442]17(`make` and `make check`) when someone makes a clean checkout. There is
[394]18a short introduction to subversion and its usage available as
[560]19[http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines].
[394]20We follow these guidelines.
21
22
[724]23=== Requirements ===
24
25To build from a subversion checkout, you will need Autotools. More
26specifically Automake 1.10 (or later) and Autoconf 2.60 (or later). To
27build man page you will need help2man.
28
[481]29=== bootstrap and autoreconf ===
[387]30
[481]31At first checkout from the repository you must run the bootstrapping
32utility
[338]33
34  `./bootstrap`
35
[481]36to setup autoconf files. To push subsequent changes of this file into
37the build scripts you run
[338]38
[481]39   `autoreconf`
[394]40
[481]41
[338]42=== configure ===
43
[387]44Run the generated configure script with
45
[555]46  `./configure --enable-debug`
[338]47
48The option flag `--enable-debug` turns on debug options (e.g. enables
[547]49assertions).
[338]50
[394]51
52=== Testing ===
53
54Test programs should be created and added to the `make check`
55execution. Always check that the test runs before committing code to
56the repository, i.e., run `make check`.
57
58There is a test repository in source:trunk/test/repo that is a part of
59the svndigest repository. The logic behind this is that it is nice to
60have a common test repository that can be used off-line. Changes to
61the repository are usually made to create new test cases and it is
62important that these changes are committed to svndigest repository as
63well. All changes to the test repository are not automatically
64propagated to the svndigest repository and it is important that some
65files created in the test repository are manually added to the
66svndigest repository. Assuming that `make check` is run before a
67commit, a warning is generated if the test repository is inconsistent
68with the svndigest repository. There will be a diagnostic message and
69a resolution hint, however the developer must examine and resolve the
70problem manually.
71
72The problem is simply that the file source:trunk/test/repo/db/current
73is changed compared to the svndigest repository. The `current` file
74indicates a specific number of change sets within the test repository
75and the directories source:trunk/test/repo/db/revs and
76source:trunk/test/repo/db/revprops contains a matching number of
77change sets. However, the change sets added to the test repository are
78not automatically added to the svndigest repository, therefore the new
79files in the `revs` and `revprops` directories must be added manually
80to the svndigest repository.
81
82There is also a race condition when developers make changes to the
83test repository simultaneously: It is easy to create severe conflicts
[583]84in the test repository. Imaging the case when two developers add test
[394]85commits to the test repository, and then tries to add these to the
86svndigest repository. Since there are different versions of the same
87test repository revisions, the second developer committing to the
88svndigest will get messages about files being in the way. This is just
89one situation with possible conflicts. This conflict is of course
90resolved by the second developer having to throw away his changes and
91redo them after a new checkout of the test repository.
92
93The take home message is that developers should communicate with each
94other when changing the test repository in order to avoid to large
95repository conflicts. AND read the output of `make check`.
96
97
[494]98=== Output file structure ===
99
100A directory reflecting the parsed directory is generated for each
101combination of StatsType, Author, and LineType, which is located in
[496]102`<TARGET>/<ROOT>/StatsType/Author/LineType/`. Author may be, on top of
103each author in the repository, a directory ''all'' that is a sum over
104all Authors. In same fashion LineType may be any of the three
105linetypes but may also ''total'', which a sum over all linetypes. In
106each `<TARGET>/<ROOT>/StatsType` there are directories
107`images/LineType` that contain a structure reflecting the parsed
108directory with images for every combination of File, LineType, and
109StatsType. Images for different Authors are identical and therefore
110shared between authors.
[494]111
112
[338]113=== Create a distribution ===
[387]114
[338]115Create a distribution package with `make dist`. Remember to test
116the package with `make distcheck`. If required packages are installed
117in non-standard locations you need to pass this information to
118`distcheck`. This is done by using the variable
119DISTCHECK_CONFIGURE_FLAGS as
120
[499]121   `DISTCHECK_CONFIGURE_FLAGS="[OPTION]..." make distcheck`
[338]122
123Usually you need to set DISTCHECK_CONFIGURE_FLAGS to whatever options
[555]124you pass to configure.
[338]125
126
[394]127== Releasing ==
[338]128
[687]129See http://dev.thep.lu.se/svndigest/wiki/ReleaseProcedure
[394]130
131
[338]132-------------------------------------------------------------------------
133{{{
[408]134Copyright (C) 2005, 2006 Jari Häkkinen
[394]135Copyright (C) 2007 Jari Häkkinen, Peter Johansson
[547]136Copyright (C) 2008 Peter Johansson
[84]137
[687]138This file is part of svndigest, http://dev.thep.lu.se/svndigest
[84]139
[149]140svndigest is free software; you can redistribute it and/or modify it
[84]141under the terms of the GNU General Public License as published by the
[693]142Free Software Foundation; either version 3 of the License, or (at your
[84]143option) any later version.
144
[149]145svndigest is distributed in the hope that it will be useful, but
146WITHOUT ANY WARRANTY; without even the implied warranty of
147MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
148General Public License for more details.
[84]149
150You should have received a copy of the GNU General Public License
[693]151along with svndigest. If not, see <http://www.gnu.org/licenses/>.
[338]152}}}
Note: See TracBrowser for help on using the repository browser.