Changeset 1721


Ignore:
Timestamp:
Jan 15, 2009, 1:58:33 PM (12 years ago)
Author:
Jari Häkkinen
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README.developer

    r1686 r1721  
    99with the additions described here.
    1010
     11=== Subversion usage ===
     12
     13Commits should be minimalistic and the project should always compile
     14(`make` and `make check`) when someone makes a clean checkout. There
     15is a short introduction to subversion and its usage available as
     16[http://cbbp.thep.lu.se/~jari/documents/subversion_guidelines/index.html
     17Subversion guidelines]. We follow these guidelines.
     18
    1119=== Testing ===
    1220
    13 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].
     21The test suite is run with `make check` at the project root directory
     22level.
     23
     24The test suite should at minimum include creation of all classes (to
     25catch linking errors) and calls to template functions (as template
     26functions are not compiled until they are needed). There is a test
     27that checks that minimum amount of documentation is written.
     28
     29For more details on writing and running tests, see file
     30[source:trunk/test/README test/README].
    1431
    1532=== Interfacing [http://www.gnu.org/software/gsl/ Gnu Scientific Library, GSL] ===
     
    3249
    3350When new GSL functionality is introduced to yat, it is the
    34 reponsibility of the programmer to make sure that GSL errors are
     51responsibility of the programmer to make sure that GSL errors are
    3552treated properly. Proper GSL error treatment is very important in
    3653cases when yat users turn off the default GSL error handler since:
     
    154171  - If you modify a function, its signature must be compatible with
    155172    previous signature, e.g., new parameters with default values may
    156     be aded to signature.
     173    be added to signature.
    157174  - Do not remove any class or inheritance for a class.
    158175
     
    184201{{{
    185202Copyright (C) 2008 Peter Johansson
     203Copyright (C) 2009 Jari Häkkinen
    186204
    187205This file is part of yat library, http://dev.thep.lu.se/yat
Note: See TracChangeset for help on using the changeset viewer.