source: trunk/README.developer @ 1451

Last change on this file since 1451 was 1299, checked in by Peter Johansson, 10 years ago

updated docs regarding required automake version when building from svn wc (and addded test to avoid future divergence

  • 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
[84]1$Id: README.developer 1299 2010-11-14 21:19:09Z peter $
[338]3= Developer Information =
5This file contains developer specific information.
8=== Coding style ===
10Developers should follow the coding style outlined in the
[560]11[ C++ coding guidelines].
14=== Subversion usage ===
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[ Subversion guidelines].
[394]20We follow these guidelines.
[724]23=== Requirements ===
25To build from a subversion checkout, you will need Autotools. More
[1299]26specifically Automake 1.11 (or later) and Autoconf 2.63 (or later). To
[724]27build man page you will need help2man.
[481]29=== bootstrap and autoreconf ===
[481]31At first checkout from the repository you must run the bootstrapping
34  `./bootstrap`
[481]36to setup autoconf files. To push subsequent changes of this file into
37the build scripts you run
[481]39   `autoreconf`
[338]42=== configure ===
[387]44Run the generated configure script with
[555]46  `./configure --enable-debug`
48The option flag `--enable-debug` turns on debug options (e.g. enables
52=== Testing ===
54Test programs should be created and added to the `make check`
55execution. Always check that the test runs before committing code to
[952]56the repository, i.e., run `make check`. For more details on how to run
57and write tests, please refer to file `test/README`.
59There is a test repository in source:trunk/test/repo that is a part of
60the svndigest repository. The logic behind this is that it is nice to
61have a common test repository that can be used off-line. Changes to
62the repository are usually made to create new test cases and it is
63important that these changes are committed to svndigest repository as
64well. All changes to the test repository are not automatically
65propagated to the svndigest repository and it is important that some
66files created in the test repository are manually added to the
67svndigest repository. Assuming that `make check` is run before a
68commit, a warning is generated if the test repository is inconsistent
69with the svndigest repository. There will be a diagnostic message and
70a resolution hint, however the developer must examine and resolve the
71problem manually.
73The problem is simply that the file source:trunk/test/repo/db/current
74is changed compared to the svndigest repository. The `current` file
75indicates a specific number of change sets within the test repository
76and the directories source:trunk/test/repo/db/revs and
77source:trunk/test/repo/db/revprops contains a matching number of
78change sets. However, the change sets added to the test repository are
79not automatically added to the svndigest repository, therefore the new
80files in the `revs` and `revprops` directories must be added manually
81to the svndigest repository.
83There is also a race condition when developers make changes to the
84test repository simultaneously: It is easy to create severe conflicts
[583]85in the test repository. Imaging the case when two developers add test
[394]86commits to the test repository, and then tries to add these to the
87svndigest repository. Since there are different versions of the same
88test repository revisions, the second developer committing to the
89svndigest will get messages about files being in the way. This is just
90one situation with possible conflicts. This conflict is of course
91resolved by the second developer having to throw away his changes and
92redo them after a new checkout of the test repository.
94The take home message is that developers should communicate with each
95other when changing the test repository in order to avoid to large
96repository conflicts. AND read the output of `make check`.
[825]99=== yat library ===
[1120]101Directory `yat/` contains some files from the yat library. These
[825]102files are not owned by svndigest and should not (if possible) be
[1120]103edited here. For more details please see `yat/README`.
[494]105=== Output file structure ===
107A directory reflecting the parsed directory is generated for each
108combination of StatsType, Author, and LineType, which is located in
[496]109`<TARGET>/<ROOT>/StatsType/Author/LineType/`. Author may be, on top of
110each author in the repository, a directory ''all'' that is a sum over
111all Authors. In same fashion LineType may be any of the three
112linetypes but may also ''total'', which a sum over all linetypes. In
113each `<TARGET>/<ROOT>/StatsType` there are directories
114`images/LineType` that contain a structure reflecting the parsed
115directory with images for every combination of File, LineType, and
116StatsType. Images for different Authors are identical and therefore
117shared between authors.
[874]119== Design and Motivation ==
[874]121Please refer to source:trunk/doc/HACKING for a list of design
122decisions we try to follow.
[394]124== Releasing ==
[978]131Copyright (C) 2005, 2006 Jari Häkkinen
132Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
[1127]133Copyright (C) 2009, 2010 Peter Johansson
[687]135This file is part of svndigest,
[149]137svndigest is free software; you can redistribute it and/or modify it
[84]138under the terms of the GNU General Public License as published by the
[693]139Free Software Foundation; either version 3 of the License, or (at your
[84]140option) any later version.
[149]142svndigest is distributed in the hope that it will be useful, but
143WITHOUT ANY WARRANTY; without even the implied warranty of
145General Public License for more details.
147You should have received a copy of the GNU General Public License
[693]148along with svndigest. If not, see <>.
Note: See TracBrowser for help on using the repository browser.