Commit Graph

749 Commits

Author SHA1 Message Date
Dana Robinson
7d53a8b837 Removed the rest of the hlog code 2021-03-02 04:34:09 -08:00
Dana Robinson
fa87a22f82 Fixes the MANIFEST
Also renames "SWMR Example.png" to SWMR_Example.png since the MANIFEST
doesn't deal with spaces very well.
2021-03-01 14:24:50 -08:00
John Mainzer
0698d23269 Merge pull request #2893 in HDFFV/hdf5 from ~MAINZER/vfd_swmr:feature/vfd_swmr to feature/vfd_swmr
* commit '47b1c667c64677d2e28c4128fc027cfdfe60b354':
  More minor edits to users guide.
  Updated users guide for location of alpha 1 release & repaired several typos.
  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.
2020-09-21 17:41:09 -05:00
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
Dana Robinson
594b17165e Removes older VFD SWMR RFC versions
These are archived in hdf5doc.
2020-09-17 14:49:48 -07: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
David Young
0ae43ff6cd Mention an improvement asked for by ITER. 2020-07-21 10:04:49 -05:00
David Young
71231f3726 Start to document the function/parameter/variable attribute macros. 2020-05-20 09:31:55 -05:00
David Young
f51f69faad Re-wrap paragraphs at < 80 columns. 2020-04-15 09:44:14 -05:00
David Young
4b40738946 Mark a task complete, fix some typos, wrap some paragraphs. 2020-04-15 09:40:17 -05:00
David Young
4dc315dfb7 Document hlog a bit. 2020-04-14 09:04:18 -05:00
David Young
9592b80913 Mention the problems VFD SWMR has with variable-length data. 2020-03-11 14:24:59 -05:00
David Young
8cc8d63d5e Update Guide. Switch to a short and informative function name. 2020-03-11 12:50:18 -05:00
David Young
ecea500047 Start a user's guide. Mention problems with variable-length data. 2020-03-10 17:21:40 -05:00
David Young
a162fbbaaa Trim excess detail. Use shadow/lower file terminology. Be less wordy about
"page or multi-page entry."
2020-02-18 09:59:10 -06:00
David Young
dfd3f782ca Share latest changes: change many occurrences of "metadata" file/index/header
to "shadow" file/index/header.  Simplify the description of freespace
management.  Finish describing the floating shadow index.
2020-02-12 16:25:22 -06:00
David Young
848219ccb8 Share my latest RFC changes. 2020-02-12 13:29:32 -06:00
David Young
2069224d0d Share my latest changes to the RFC. 2020-02-11 13:43:58 -06:00
David Young
89247be681 Add latest commentary on RFC. 2020-02-11 13:43:58 -06:00
David Young
251d62c5dd Update punch list a bit: mention the over-long postponement of shadow-index
reclamation.  Mention that a writer can delete an object out from under a
reader who holds an hid_t for it.
2020-02-06 16:06:13 -06:00
David Young
ba9dd0b871 Escape some underscores. I'm not sure if this is strictly necessary, but vim's
syntax highlighting colors some (but not all) unescaped underscores red like
there is some problem.  It's possible there is some problem, since underscores
are used to indicate some kind of emphasis---probably underlining.
2020-02-06 16:04:47 -06:00
Mike Folk
fbcbf76907 Update VFD_SWMR_Punch_List.md 2020-02-06 13:37:07 -06:00
Mike Folk
ae61a8e826 Update VFD_SWMR_Punch_List.md 2020-02-04 15:25:06 -06:00
David Young
b34e6d2f45 Add some missing spaces. 2020-01-27 13:41:42 -06:00
David Young
33ea1d2b06 Add my newest commentary. Finally reached page 14! 2020-01-17 17:25:38 -06:00
David Young
c09a9e90e1 Update punchlist a bit with John: add some items, update entries that are now
complete.
2020-01-09 11:41:02 -06:00
David Young
0b11cfbf50 Add a new version of the RFC with some commentary by me. 2020-01-08 17:27:43 -06:00
David Young
0ec3340692 Makes some updates: in-progress, needs unit testing. Insert some whitespace
where it makes things more readable.
2020-01-06 15:48:34 -06:00
David Young
12ea13f745 Mention the current situation concerning raw-data flushing. 2019-12-31 09:58:19 -06:00
David Young
68b012f017 Mention that I fixed the VFD SWMR tests. 2019-12-30 16:59:15 -06:00
David Young
c8f533cfc3 Merge all of my changes from merge-back-to-feature-vfd_swmr-attempt-1,
including the merge of `hdffv/hdf5/develop`, back to the branch that Vailin and
I share.

Now I need to put this branch on a fork with a less confusing name than
vchoi_fork!
2019-12-09 10:30:58 -06:00
Vailin Choi
adcf8a315e Fix the FSM bug when setting the FSM threshold to a non-default value.
Check for smaller or larger section size after merging and shrinking a section,
for this case is the section that is smaller than threshold (see H5MF_xfree() in H5MF.c).
It is possible for the section to be smaller after merging/shrinking (see H5MF__sect_large_shrink()
in H5MFsection.c).
2019-12-02 11:07:25 -06:00
David Young
4d50f9a7a8 Update status of the expand/shrink test. 2019-11-25 11:01:42 -06:00
David Young
0f9678b415 Mention the Markdown cheat sheet and tutorial, per John's request. 2019-11-22 15:36:56 -06:00
Vailin Choi
12438c22b7 Fix for punch list #28:
Given that the VFD SWMR configuration FAPL property is set, the writer field must
be consistent with the flags passed in the H5Fopen() (either H5F_ACC_RDWR for the
VFD SWMR writer, or H5F_ACC_RDONLY for the VFD SWMR readers).
2019-11-20 16:23:03 -06:00
Vailin Choi
68ad19d9cc Changes for punch list #4: Add support for opening mulitple files in either VFD SWMR writer or reader mode. See EOT queue in section 3.2.2 and 3.3 and 3.3.2 in the RFC.
Update punch list with items completed and in progress.
2019-11-20 11:39:26 -06:00
David Young
d3055b85b9 Add my name to some entries. 2019-11-19 17:16:06 -06:00
David Young
65c38da1f0 Mention the items that Vailin is working on. 2019-11-19 16:35:02 -06:00
David Young
7579e10abb Use bold to highlight items status. 2019-11-19 15:53:57 -06:00
David Young
898871545d Add some notes about what's done and what I'm working on. 2019-11-19 15:52:38 -06:00