diff options
Diffstat (limited to 'model/README')
| -rw-r--r-- | model/README | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/model/README b/model/README new file mode 100644 index 0000000000000..cf13a82b7338a --- /dev/null +++ b/model/README @@ -0,0 +1,11 @@ +This directory contains the classes that form the data model of Kyua. + +The classes in this directory are intended to be pure data types without +any complex logic. As such, they are simple containers and support the +common operations you would expect from them: in particular, comparisons +and formatting for debugging purposes. + +All the classes in the data model have to have an on-disk representation +provided by the store module; if they don't, they don't belong in the +model. Some of these classes may also have special behavior at run-time, +and this is provided by the engine module. |