config_host/README.md

   1 # C/C++ Configuration Created by configure Script
   2
   3 These are configuration files for various features as detected by `configure`.
   4
   5 Include only those files you need (in order to reduce rebuilds when a setting changes).
   6
   7 Settings here are only C/C++ `#define` directives, so they apply only to C/C++ source,
   8 not to Makefiles.
   9
  10 ## Adding a New Setting:
  11
  12 - do `AC_DEFINE(HAVE_FOO)` in `configure.ac` when a setting should be set
  13 - choose the proper `config_host/config_XXX.h` file to use
  14     - if it is a global setting (such as availability of a compiler feature),
  15         use `config_host/config_global.h`
  16     - otherwise check if there is a matching `config_host/config_XXX.h` file
  17     - if none matches, add a new one:
  18         - add `config_host/config_XXX.h.in` here, with just `#ifndef` include guard
  19         - add `AC_CONFIG_HEADERS([config_host/config_XXX.h])` next to the others
  20             in `configure.ac`
  21 - add `#define HAVE_FOO 0` to the `config_host/config_XXX.h`, possibly with a comment
  22   (do not use `#undef HAVE_FOO`, unless the setting has more values than on/off)
  23 - add `#include <config_XXX.h>` before any #if `HAVE_FOO` in a source file
  24 - make sure you use `#if HAVE_FOO` for on/off settings, do not use `#ifdef`