MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-06-01 01:28:54 +02:00
Code Issues Releases Wiki Activity

ircd::conf: Update doc related to conf item env vars and the related namespace.

Browse source
This commit is contained in:
Jason Volk 2018-12-28 13:36:23 -08:00
parent d786079fca
commit a4ed2debd4
2 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
include/ircd/README.md
View file

@ -2,12 +2,13 @@
#### Project Namespaces
* `IRCD_` Preprocessor #define, macro, and environmental variables.
* `IRCD_` Preprocessor #define and macros.
* `RB_` Build system related preprocessor #defines and macros (legacy).
* `ircd_` C namespace and demangled bindings.
* `ircd::` C++ namespace scope.
* `X-IRCd-` HTTP header key namespace.
* `ircd.` Matrix event type namespace.
* `ircd_` Environmental variables (see: conf.h).
#### What To Include

6
include/ircd/conf.h
View file

@ -23,6 +23,12 @@
/// O(1) access to the value contained in their item instance. Administrators
/// have logarithmic access through this interface using the items map by name.
///
/// All conf::items can be controlled by environmental variables at program
/// startup. The name of the conf::item in the environment uses underscore
/// '_' rather than '.' and the environment takes precedence over both defaults
/// and databased values. This means you can set a conf through an env var
/// to override a broken value.
///
namespace ircd::conf
{
template<class T = void> struct item; // doesn't exist