xref: /freebsd/contrib/kyua/model/README (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1This directory contains the classes that form the data model of Kyua.
2
3The classes in this directory are intended to be pure data types without
4any complex logic.  As such, they are simple containers and support the
5common operations you would expect from them: in particular, comparisons
6and formatting for debugging purposes.
7
8All the classes in the data model have to have an on-disk representation
9provided by the store module; if they don't, they don't belong in the
10model.  Some of these classes may also have special behavior at run-time,
11and this is provided by the engine module.
12