diff options
| author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-19 15:47:54 +0200 |
|---|---|---|
| committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-04-21 15:58:41 +0200 |
| commit | 041b70cd1cd7883a12a71612784d937361aa5efd (patch) | |
| tree | 098cc98f73c5f1e71fe6b6bacc6d08cc4b921f9a | |
| parent | Remove old unit-test style seraliazation tests. (diff) | |
| download | calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.gz calp-041b70cd1cd7883a12a71612784d937361aa5efd.tar.xz | |
Split data-store and data-format indo separate doc pages.
| -rw-r--r-- | doc/ref/guile.texi | 3 | ||||
| -rw-r--r-- | doc/ref/guile/data-formats.texi | 25 | ||||
| -rw-r--r-- | doc/ref/guile/data-stores.texi (renamed from doc/ref/guile/save-load.texi) | 37 |
3 files changed, 32 insertions, 33 deletions
diff --git a/doc/ref/guile.texi b/doc/ref/guile.texi index d5783a7f..5430c92a 100644 --- a/doc/ref/guile.texi +++ b/doc/ref/guile.texi @@ -1,7 +1,8 @@ @node Guile @chapter Guile -@include guile/save-load.texi +@include guile/data-formats.texi +@include guile/data-stores.texi @include guile/datetime.texi @include guile/zic.texi @include guile/srfi-41.texi diff --git a/doc/ref/guile/data-formats.texi b/doc/ref/guile/data-formats.texi new file mode 100644 index 00000000..037d3ae7 --- /dev/null +++ b/doc/ref/guile/data-formats.texi @@ -0,0 +1,25 @@ +@node Data Formats +@section Data Formats +A data format is some way that an individual event may get serialized +to disk. The default is iCalendar (TODO reference RFC 5545), but +others might be available (TODO footnote and reference xcal). + +Each available format should be included as +@code{(vcomponent formats @var{format-name})}. +Which module corresponds to what file type is currently defined out of band. + +Each module should expose the following procedures. + +@defun serialize component port +Write a serialized representation of @var{component} to @var{port}. +@end defun + +@defun deserialize port +Read a serialized representation of a component from @var{port}, and +return the deserialized instance of this object. +@end defun + +@subsection iCalendar +RFC 5545 + +@subsection xCal diff --git a/doc/ref/guile/save-load.texi b/doc/ref/guile/data-stores.texi index 136b2f39..ec3962da 100644 --- a/doc/ref/guile/save-load.texi +++ b/doc/ref/guile/data-stores.texi @@ -1,32 +1,5 @@ -@node Saving and Loading -@section Saving and Loading - -@subsection Data Formats -A data format is some way that an individual event may get serialized -to disk. The default is iCalendar (TODO reference RFC 5545), but -others might be available (TODO footnote and reference xcal). - -Each available format should be included as -@code{(vcomponent formats @var{format-name})}. -Which module corresponds to what file type is currently defined out of band. - -Each module should expose the following procedures. - -@defun serialize component port -Write a serialized representation of @var{component} to @var{port}. -@end defun - -@defun deserialize port -Read a serialized representation of a component from @var{port}, and -return the deserialized instance of this object. -@end defun - -@subsubsection iCalendar -RFC 5545 - -@subsubsection xCal - -@subsection Data Stores +@node Data Stores +@section Data Stores Data stores are persistant stores for events, such as databases or the file system. Each data store can support any number of data formats, but which is an implementation detail of that format and shouldn't be @@ -55,9 +28,9 @@ Queue a save event of @var{event} to the store. Force write of all queued actions. @end deftp -@subsubsection VDir +@subsection VDir [VDIR]: http://vdirsyncer.pimutils.org/en/latest/vdir.html -@subsubsection File +@subsection File -@subsubsection SQLite +@subsection SQLite |