libcxx/NOTES.TXT

   1 //===---------------------------------------------------------------------===//
   2 // Notes relating to various libc++ tasks
   3 //===---------------------------------------------------------------------===//
   4
   5 This file contains notes about various libc++ tasks and processes.
   6
   7 //===---------------------------------------------------------------------===//
   8 // Post-Release TODO
   9 //===---------------------------------------------------------------------===//
  10
  11 These notes contain a list of things that must be done after branching for
  12 an LLVM release.
  13
  14 1. Update _LIBCPP_VERSION in `__config`
  15 2. Update the __libcpp_version file.
  16 3. Update the version number in `docs/conf.py`
  17 4. Create ABI lists for the previous release under `lib/abi`
  18
  19 //===---------------------------------------------------------------------===//
  20 // Adding a new header TODO
  21 //===---------------------------------------------------------------------===//
  22
  23 These notes contain a list of things that must be done upon adding a new header
  24 to libc++.
  25
  26 1. Add a test under `test/libcxx` that the header defines `_LIBCPP_VERSION`.
  27 2. Update `test/libcxx/double_include.sh.cpp` to include the new header.
  28 3. Create a submodule in `include/module.modulemap` for the new header.
  29 4. Update the include/CMakeLists.txt file to include the new header.