folly/portability/README.md

   1 Warning
   2 =======
   3
   4 These portability headers are **internal implementation details**.
   5
   6 They are intended to ensure that Folly can build on a variety of platforms.
   7
   8 They are not intended to help you build your programs on these platforms.
   9
  10 They are, and will remain, undocumented. They are, and will remain, subject to
  11 rapid, immediate, and drastic changes - including full rewrites and merciless
  12 deletions - without notice.
  13
  14 Note that before adding a new file to this directory you should determine
  15 whether the API you are adding is a portability header or just a platform
  16 dependent implementation detail. Only portability headers belong in this
  17 directory. A portability header is defined as a header that provides the exact
  18 API of some platform or configuration that is not available on all platforms.
  19 If the API being added does not already exist on at least one of the platforms
  20 Folly supports, then it is an implementation detail, and does not belong in
  21 this directory.