Changeset 1721

Timestamp:

Jan 15, 2009, 1:58:33 PM (15 years ago)

Author:

Jari Häkkinen

Message:

Addresses #458. Added a paragraph on subversion, added information on documentation test, spellchecked file.

File:

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

trunk/README.developer

@@ -9 +9 @@
 with the additions described here.
 
+=== Subversion usage ===
+
+Commits should be minimalistic and the project should always compile
+(`make` and `make check`) when someone makes a clean checkout. There
+is a short introduction to subversion and its usage available as
+[http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html
+Subversion guidelines]. We follow these guidelines.
+
 === Testing ===
 
-The test suite should at minimum include creation of all classes (to catch linking errors) and calls to template functions (as template functions are not compiled until they are needed). For more details on writing test, see file [source:trunk/test/README test/README].
+The test suite is run with `make check` at the project root directory
+level.
+
+The test suite should at minimum include creation of all classes (to
+catch linking errors) and calls to template functions (as template
+functions are not compiled until they are needed). There is a test
+that checks that minimum amount of documentation is written.
+
+For more details on writing and running tests, see file
+[source:trunk/test/README test/README].
 
 === Interfacing [http://www.gnu.org/software/gsl/ Gnu Scientific Library, GSL] ===
@@ -32 +49 @@
 
 When new GSL functionality is introduced to yat, it is the
-reponsibility of the programmer to make sure that GSL errors are
+responsibility of the programmer to make sure that GSL errors are
 treated properly. Proper GSL error treatment is very important in
 cases when yat users turn off the default GSL error handler since:
@@ -154 +171 @@
   - If you modify a function, its signature must be compatible with
     previous signature, e.g., new parameters with default values may
-    be aded to signature.
+    be added to signature.
   - Do not remove any class or inheritance for a class.
 
@@ -184 +201 @@
 {{{
 Copyright (C) 2008 Peter Johansson
+Copyright (C) 2009 Jari Häkkinen
 
 This file is part of yat library, http://dev.thep.lu.se/yat