Commit Graph

12 Commits

Author SHA1 Message Date
mainzer
47b1c667c6 More minor edits to users guide. 2020-09-21 17:38:18 -05:00
mainzer
2dd0cbe9a7 Updated users guide for location of alpha 1 release & repaired
several typos.
2020-09-21 17:30:06 -05:00
mainzer
3696129c7b Added .pdf and .docx versions of the most recent version of the
VFD SWMR RFC.  Updates on the RFC are cursory, and mostly in the
introduction.  The design section is dated -- added a warning to
this effect.

Reviewed and editied the users guide -- specifically:

   Verified instructions for build and test, and also for demos.
   Removed mention of call to autogen.sh, as that will already be
   run on the friendly user release version.

   Re-worked the introduction to better discribe VFD SWMR, and
   to outline current limitations.

   Changed references to "shadow file" to "metadata file" to match
   field names.

Still need to update pointer to the bit-bucket repository for the
friendly user release.

Also, must verify that the demo code mentioned in the user guide
is publicly available.
2020-09-21 09:01:06 -05:00
David Young
69f4053692 Move the open issues noted in the outdated VFD_SWMR_Guide.md to
vfd-swmr-user-guide.md and delete VFD_SWMR_Guide.md.
2020-09-14 12:41:27 -05:00
David Young
68643772e3 Mention that creating new objects is not possible with legacy SWMR.
Add abbreviation TBD where we need to add a hyperlink.
2020-09-03 14:58:15 -05:00
David Young
101f040b80 Add Dana's words about MS Windows support. 2020-09-03 14:58:15 -05:00
David Young
135af42c09 Describe the command-line options for the bigset reader/writer
with a handful of bullets.
2020-09-02 10:50:34 -05:00
David Young
bfc42a18ce Don't pass CFLAGS to the configure script, that's not in the HDF5 configure
idiom and it's just too much detail.

Repair a TBD: mention the vfdswmr@hdfgroup.org address for contacting the VFD
SWMR developers.
2020-09-02 10:06:20 -05:00
David Young
599be55d97 Be less specific about Windows support. 2020-08-31 17:01:50 -05:00
David Young
e1419c872e Do not use first person singular in the SWMR demos section.
In the `vfd_swmr_create_fapl()` dissection, change the /** **/
comments in the literal code to plain markdown paragraphs.

Slightly change wording and markdown elsewhere.
2020-08-25 10:46:36 -05:00
David Young
da4c72a138 Incorporate Mike's changes, fix some of my punctuation and markdown. 2020-08-25 10:23:01 -05:00
David Young
c492036b0d Add the VFD SWMR User's Guide, a work in progress. 2020-08-25 09:22:04 -05:00