aboutsummaryrefslogtreecommitdiff
path: root/src/leveldb/port/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/leveldb/port/README.md')
-rw-r--r--src/leveldb/port/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/leveldb/port/README.md b/src/leveldb/port/README.md
new file mode 100644
index 0000000000..8b171532e1
--- /dev/null
+++ b/src/leveldb/port/README.md
@@ -0,0 +1,10 @@
+This directory contains interfaces and implementations that isolate the
+rest of the package from platform details.
+
+Code in the rest of the package includes "port.h" from this directory.
+"port.h" in turn includes a platform specific "port_<platform>.h" file
+that provides the platform specific implementation.
+
+See port_stdcxx.h for an example of what must be provided in a platform
+specific header file.
+