Skip to content

Commit

Permalink
Reword GSD_CHARACTER definition in docs.
Browse files Browse the repository at this point in the history
joaander committed Sep 25, 2024
1 parent ffe1652 commit 6f37b8f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/file-layer.rst
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ File layer

.. highlight:: c

**Version: 2.0**
**Version: 2.x**

General simulation data (GSD) **file layer** design and rationale. These use
cases and design specifications define the low level GSD file format.
@@ -236,5 +236,8 @@ A data block stores raw data bytes on the disk. For a given index entry
``entry``, the data starts at location ``entry.location`` and is the next
``entry.N * entry.M * gsd_sizeof_type(entry.type)`` bytes.

The type fields are self-explanatory except for UTF-8 strings, for which
null-termination is allowed but not required.
Added in version 2.1
^^^^^^^^^^^^^^^^^^^^

* The ``GSD_CHARACTER`` chunk type represents a UTF-8 string (null termination is allowed, but not
required).

0 comments on commit 6f37b8f

Please sign in to comment.