summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
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.