obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

Updated the documentation

Browse Source
This commit is contained in:
Celine Mercier
2015-05-22 17:52:55 +02:00
parent 2395688bd3
commit f60a98a21d
2 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/formats.rst
View File

@ -140,7 +140,7 @@ or more (if there are several versions), and that there is one file per version.
Versioning 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. number by 1.
The number of the latest version of an OBIDMS column is stored in an `OBIDMS release file <formats.html#obidms-release-files>`_. The number of the latest version of an OBIDMS column is stored in an `OBIDMS release file <formats.html#obidms-release-files>`_.
@ -175,7 +175,7 @@ OBIDMS history file
An OBIDMS history file consists of an ordered list of views and commands, those commands leading An OBIDMS history file consists of an ordered list of views and commands, those commands leading
from one view to the next one. 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 : operations ever done in the OBIDMS directory and the views in between them :
.. image:: ./images/history.png .. image:: ./images/history.png
@ -190,6 +190,12 @@ OBIDMS UML
:download:`html version of the OBIDMS UML file </ObiDMS_UML.class.violet.html>` :download:`html version of the OBIDMS UML file </ObiDMS_UML.class.violet.html>`
OBIType header file
========================
.. doxygenfile:: obitypes.h
OBIIntColumn header file OBIIntColumn header file
======================== ========================

5
doc/source/pistes.rst
View File

@ -9,7 +9,8 @@ Ce que l'on veut pouvoir faire
* Gerer les valeurs manquantes * Gerer les valeurs manquantes
* Modifier une colonne en cours d'ecriture (mmap) * 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). * 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... * Utilisation de semaphores pour la lecture