API: Format documentation about namespaces
@@ -121,33 +121,39 @@ which appears like a tree on its own.
See @ref cascading in the documentation of ksLookupByName() on how the selection
of keys works.
-- The `spec` tree\n
+- The `spec` tree
+
This tree specifies how the lookup should take place and also allows us to
define defaults or document a key.
The metadata of a key contains this information:
- + `override/#`: use these keys *in favour* of the key itself (note that
- `#` is the syntax for arrays, e.g. `#0` for the first element,
- `#10` for the 11th and so on)
- + `namespace/#`: instead of using all namespaces in the predefined order,
+
+ - `override/#`: use these keys *in favour* of the key itself (note that
+ - `#` is the syntax for arrays, e.g. `#0` for the first element,
+ -`#10` for the 11th and so on)
+ - `namespace/#`: instead of using all namespaces in the predefined order,
one can specify which namespaces should be searched in which order
- + `fallback/#`: when no key was found in any of the (specified) namespaces
+ - `fallback/#`: when no key was found in any of the (specified) namespaces
the `fallback`-keys will be searched
- + `default`: this value will be used if nothing else was found
+ - `default`: this value will be used if nothing else was found
+
+- The `proc` tree
-- The `proc` tree\n
Is the only read-only tree. The configuration does not stem from the
[KDB (Key Database)](@ref kdb), but any other source, e.g. command-line arguments or environment.
-- The `dir` tree\n
+- The `dir` tree
+
Allows us to have a per-directory overwrite of configuration files, e.g.
for project specific settings.
-- The `user` tree\n
+- The `user` tree
+
Used to store user-specific configurations, like the personal settings
of a user to certain programs. The user subtree will always be favoured
if present (except for security concerns the user subtree may not be considered).
-- The `system` tree\n
+- The `system` tree
+
It is provided to store system-wide configuration keys, that is,
the last fallback for applications but the only resort for
daemons and system services.
