diff options
| author | David Young <dyoung@hdfgroup.org> | 2020-03-10 22:21:40 (GMT) |
|---|---|---|
| committer | David Young <dyoung@hdfgroup.org> | 2020-03-10 22:21:40 (GMT) |
| commit | ecea500047a1b55d0da59a01dc8ad64b5757f602 (patch) | |
| tree | ab522cc71e2774ae63c15674c608e9422de1da58 /doc/VFD_SWMR_Guide.md | |
| parent | 3f2e3659c2069a466aae11266b789c72fe76d8a5 (diff) | |
| download | hdf5-ecea500047a1b55d0da59a01dc8ad64b5757f602.zip hdf5-ecea500047a1b55d0da59a01dc8ad64b5757f602.tar.gz hdf5-ecea500047a1b55d0da59a01dc8ad64b5757f602.tar.bz2 | |
Start a user's guide. Mention problems with variable-length data.
Diffstat (limited to 'doc/VFD_SWMR_Guide.md')
| -rw-r--r-- | doc/VFD_SWMR_Guide.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/VFD_SWMR_Guide.md b/doc/VFD_SWMR_Guide.md new file mode 100644 index 0000000..22dd0ca --- /dev/null +++ b/doc/VFD_SWMR_Guide.md @@ -0,0 +1,12 @@ +# VFD SWMR User's Guide + +## Caveats + +A few library functions are known to work incorrectly with VFD +SWMR. + +* Variable-length data written using VFD SWMR may be inaccessible + or inconsistent to a VFD SWMR reader until the writer closes + the file. Instead of the proper variable-length data, a reader may + read NULL or arbitrary bytes. Inconsistencies may also cause the + reader to crash. |