summaryrefslogtreecommitdiffstats
path: root/src/pmdk/src/freebsd/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/pmdk/src/freebsd/README')
-rw-r--r--src/pmdk/src/freebsd/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/pmdk/src/freebsd/README b/src/pmdk/src/freebsd/README
new file mode 100644
index 000000000..f0f065d88
--- /dev/null
+++ b/src/pmdk/src/freebsd/README
@@ -0,0 +1,13 @@
+Persistent Memory Development Kit
+
+This is src/freebsd/README.
+
+This directory contains FreeBSD-specific files for the Persistent Memory Development Kit.
+
+The subdirectory "include" contains header files that have no equivalents
+on FreeBSD. Most of these files are empty, which is a cheap trick to avoid
+preprocessor errors when including non-existing files. Others are redirects
+for files that are in different locations on FreeBSD. This way we don't
+need a lot of preprocessor conditionals in all the source code files, although
+it does require conditionals in the Makefiles (which could be addressed by
+using autoconf).