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