libcxx/modules/README.md

   1 # The "module partitions" for the std module
   2
   3 The files in this directory contain the exported named declarations per header.
   4 These files are used for the following purposes:
   5
   6  - During testing exported named declarations are tested against the named
   7    declarations in the associated header. This excludes reserved names; they
   8    are not exported.
   9  - Generate the module std.
  10
  11 These use cases require including the required headers for these "partitions"
  12 at different locations. This means the user of these "partitions" are
  13 responsible for including the proper header and validating whether the header can
  14 be loaded in the current libc++ configuration. For example "include <locale>"
  15 fails when locales are not available. The "partitions" use the libc++ feature
  16 macros to export the declarations available in the current configuration. This
  17 configuration is available if the user includes the `__config' header.
  18
  19 We use `.inc` files that we include from the top-level module instead of
  20 using real C++ module partitions. This is a lot faster than module partitions,
  21 see [this](https://discourse.llvm.org/t/alternatives-to-the-implementation-of-std-modules/71958) for details.