summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDana Robinson <43805+derobins@users.noreply.github.com>2021-08-04 17:07:21 (GMT)
committerGitHub <noreply@github.com>2021-08-04 17:07:21 (GMT)
commita7f3feee8718450c3e32fcbb2f90065240b6b9b5 (patch)
tree76dcc9ea92df237cf081f8988b6315f6db78475e /doc
parent3082cd226e7affcf693cc9f4e0380880c029a141 (diff)
downloadhdf5-a7f3feee8718450c3e32fcbb2f90065240b6b9b5.zip
hdf5-a7f3feee8718450c3e32fcbb2f90065240b6b9b5.tar.gz
hdf5-a7f3feee8718450c3e32fcbb2f90065240b6b9b5.tar.bz2
VFD SWMR: UG updates from beta 1 (#878)
* Brings MacOS basename fix from feature/vfd_swmr (#875) * Updated the user's guide with a note about debug builds
Diffstat (limited to 'doc')
-rw-r--r--doc/vfd-swmr-user-guide.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/vfd-swmr-user-guide.md b/doc/vfd-swmr-user-guide.md
index ee7df64..a4375b3 100644
--- a/doc/vfd-swmr-user-guide.md
+++ b/doc/vfd-swmr-user-guide.md
@@ -94,6 +94,13 @@ There are no special instructions for building VFD SWMR. Simply follow
the usual build procedure for CMake or the Autotools using the guides
in the `release_docs` directory.
+IMPORTANT:
+
+The VFD SWMR branches are maintenance branches and will default to a debug
+build. They also do not come with generated files, so Perl will be required
+when building with CMake and Perl and the Autotools (autoconf, etc.) will
+be required when building with the Autotools.
+
Some notes:
- The mirror VFD tests require some rework, so enabling that feature will cause the build step to fail. This will be fixed in a future beta release.