Changeset 394 for trunk

Timestamp:

Jun 25, 2007, 9:37:08 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Fixes #202. wiki developer information moved to README.developer.

File:

• trunk/README.developer (modified) (4 diffs)

trunk/README.developer

@@ -4 +4 @@
 
 This file contains developer specific information.
+
+
+=== Coding style ===
+
+Developers should follow the coding style outlined in the
+[http://www.thep.lu.se/~jari/documents/c++_coding_guidelines/index.html C++ coding guidelines].
+
+
+=== Subversion usage ===
+
+Commits should be minimalistic and the projects should always compile
+(`make` and `make test`) when someone makes a clean checkout. There is
+a short introduction to subversion and its usage available as
+[http://www.thep.lu.se/~jari/documents/subversion_guidelines/index.html Subversion guidelines].
+We follow these guidelines.
+
 
 === bootstrap === 
@@ -13 +29 @@
 
 to setup autoconf files.
+
 
 === configure ===
@@ -24 +41 @@
 additional tests. All tests are not enabled by default since some of
 the tests depend on being run from a subversion WC.
+
+
+=== Testing ===
+
+Test programs should be created and added to the `make check`
+execution. Always check that the test runs before committing code to
+the repository, i.e., run `make check`.
+
+There is a test repository in source:trunk/test/repo that is a part of
+the svndigest repository. The logic behind this is that it is nice to
+have a common test repository that can be used off-line. Changes to
+the repository are usually made to create new test cases and it is
+important that these changes are committed to svndigest repository as
+well. All changes to the test repository are not automatically
+propagated to the svndigest repository and it is important that some
+files created in the test repository are manually added to the
+svndigest repository. Assuming that `make check` is run before a
+commit, a warning is generated if the test repository is inconsistent
+with the svndigest repository. There will be a diagnostic message and
+a resolution hint, however the developer must examine and resolve the
+problem manually.
+
+The problem is simply that the file source:trunk/test/repo/db/current
+is changed compared to the svndigest repository. The `current` file
+indicates a specific number of change sets within the test repository
+and the directories source:trunk/test/repo/db/revs and
+source:trunk/test/repo/db/revprops contains a matching number of
+change sets. However, the change sets added to the test repository are
+not automatically added to the svndigest repository, therefore the new
+files in the `revs` and `revprops` directories must be added manually
+to the svndigest repository.
+
+There is also a race condition when developers make changes to the
+test repository simultaneously: It is easy to create severe conflicts
+in the test repository. Imaging the case when two developers adds test
+commits to the test repository, and then tries to add these to the
+svndigest repository. Since there are different versions of the same
+test repository revisions, the second developer committing to the
+svndigest will get messages about files being in the way. This is just
+one situation with possible conflicts. This conflict is of course
+resolved by the second developer having to throw away his changes and
+redo them after a new checkout of the test repository.
+
+The take home message is that developers should communicate with each
+other when changing the test repository in order to avoid to large
+repository conflicts. AND read the output of `make check`.
+
 
 === Create a distribution ===
@@ -42 +106 @@
 
 
-Also see http://lev.thep.lu.se/trac/svndigest/wiki/DeveloperInformation
+== Releasing ==
+
+See http://lev.thep.lu.se/trac/svndigest/wiki/ReleaseProcedure
+
 
 -------------------------------------------------------------------------
 {{{
 Copyright (C) 2006 Jari Häkkinen
-Copyright (C) 2007 Jari Häkkinen Peter Johansson
+Copyright (C) 2007 Jari Häkkinen, Peter Johansson
 
 This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest