From f60a98a21d4dda5cb6b93b4e4e53604af46288f7 Mon Sep 17 00:00:00 2001 From: Celine Mercier Date: Fri, 22 May 2015 17:52:55 +0200 Subject: [PATCH] Updated the documentation --- doc/source/formats.rst | 10 ++++++++-- doc/source/pistes.rst | 5 +++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/source/formats.rst b/doc/source/formats.rst index b4d2ced..ae4bad6 100644 --- a/doc/source/formats.rst +++ b/doc/source/formats.rst @@ -140,7 +140,7 @@ or more (if there are several versions), and that there is one file per version. Versioning ---------- -The first version of a column file is numbered 1, and each new version increments that +The first version of a column file is numbered 0, and each new version increments that number by 1. The number of the latest version of an OBIDMS column is stored in an `OBIDMS release file `_. @@ -175,7 +175,7 @@ OBIDMS history file An OBIDMS history file consists of an ordered list of views and commands, those commands leading from one view to the next one. -This history can be represented in the form of a --- showing all the +This history can be represented in the form of a ?? showing all the operations ever done in the OBIDMS directory and the views in between them : .. image:: ./images/history.png @@ -190,6 +190,12 @@ OBIDMS UML :download:`html version of the OBIDMS UML file ` +OBIType header file +======================== + +.. doxygenfile:: obitypes.h + + OBIIntColumn header file ======================== diff --git a/doc/source/pistes.rst b/doc/source/pistes.rst index 53ed591..58388d6 100644 --- a/doc/source/pistes.rst +++ b/doc/source/pistes.rst @@ -9,7 +9,8 @@ Ce que l'on veut pouvoir faire * Gerer les valeurs manquantes * Modifier une colonne en cours d'ecriture (mmap) - * Ajouter des valeurs a la fin d'une colonne en cours d'ecriture (mmap) + * Ajouter des valeurs a la fin du fichier d'une colonne en cours d'ecriture (mmap) + * ****** @@ -17,4 +18,4 @@ Divers ****** * Si l'ordre d'une colonne est change, elle est reecrite (pas d'index). -* Truc pour verrouiller l'acces en lecture a un programme a la fois... \ No newline at end of file +* Utilisation de semaphores pour la lecture