From: Yedidya Feldblum <yfeldblum@fb.com>
Date: Sat, 5 Mar 2016 00:48:27 +0000 (-0800)
Subject: A warning for the portability headers
X-Git-Tag: deprecate-dynamic-initializer~3
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=22a8195eb7ee64ecfa8d2d13f15422d422416a71;p=folly.git

A warning for the portability headers

Summary: [Folly] A warning for the `portability` headers.

Reviewed By: mzlee, Orvid, meyering

Differential Revision: D3014442

fb-gh-sync-id: f6557d8021dc2a50a656685492d717fdbff1124a
shipit-source-id: f6557d8021dc2a50a656685492d717fdbff1124a
---

diff --git a/folly/portability/README.md b/folly/portability/README.md
new file mode 100644
index 00000000..01e97e7a
--- /dev/null
+++ b/folly/portability/README.md
@@ -0,0 +1,12 @@
+Warning
+=======
+
+These portability headers are **internal implementation details**.
+
+They are intended to ensure that Folly can build on a variety of platforms.
+
+They are not intended to help you build your programs on these platforms.
+
+They are, and will remain, undocumented. They are, and will remain, subject to
+rapid, immediate, and drastic changes - including full rewrites and merciless
+deletions - without notice.