aboutsummaryrefslogtreecommitdiff
path: root/port/README
diff options
context:
space:
mode:
authorVinnie Falco <vinnie.falco@gmail.com>2013-05-03 19:06:59 -0700
committerVinnie Falco <vinnie.falco@gmail.com>2013-05-03 19:06:59 -0700
commitc25e98186d0f716451ef000e55646d25e014f573 (patch)
treeaaf23800da380d055ecf533422905018eb8b6fe2 /port/README
Squashed 'src/leveldb/' content from commit aca1ffc
git-subtree-dir: src/leveldb git-subtree-split: aca1ffc4b65be5e099b2088c6e6a308d69e1ad73
Diffstat (limited to 'port/README')
-rw-r--r--port/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/port/README b/port/README
new file mode 100644
index 0000000000..422563e25c
--- /dev/null
+++ b/port/README
@@ -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_posix.h for an example of what must be provided in a platform
+specific header file.
+