Skip to content

Commit 63ac003

Browse files
committed
doc: update mtformat.rst with corrections and extra notes
1 parent a2c814f commit 63ac003

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/mtformat.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,18 @@ All integers are to be in little-endian form.
2020

2121
* ``char magic[8] = "GXMT0004";``
2222
Magic fixed value to indicate the MT stream revision.
23-
* ``uint32_t splice_flag;``
23+
* ``uint8_t splice_flag;``
2424
Indicates whether the root object of this MT stream is to become a new folder
2525
in the target mailbox (0), or whether the objects in this stream are to be
2626
spliced (1) into preexisting folders of a mailbox.
27-
* ``uint32_t public_store_flag;``
27+
* ``uint8_t public_store_flag;``
2828
Indicates whether this MT stream was generated from a private (0) or public
2929
store (1) and whether folder IDs appearing in ``target_nid`` use the magic
3030
values from the ``PRIVATE_FID_`` or ``PUBLIC_FID_`` sets for built-in
3131
folders.
3232
* ``uint64_t fm_size;``
33-
Size in bytes for the folder map section that follows.
33+
Size in bytes for the folder map section that follows. This must be non-zero,
34+
i.e. fm_entires needs to be present, even if fm_entries is 0.
3435
* Folder map:
3536
* ``uint64_t fm_entries;``
3637
The number of entries in the folder map
@@ -48,7 +49,8 @@ All integers are to be in little-endian form.
4849
* ``char name[];``
4950
NUL-terminated folder name string for newly created folders.
5051
* ``uint64_t np_size;``
51-
Size in bytes for the named property map section that follows.
52+
Size in bytes for the named property map section that follows. This must be
53+
non-zero, i.e. np_entries needs to be present, even if np_entries is 0.
5254
* Named Property map:
5355
* ``uint64_t np_entries;``
5456
Number of entries in the NP map

0 commit comments

Comments
 (0)