Namespaces: Mark code spans
@@ -10,7 +10,7 @@ the same configuration item from different sources, e.g.:
- by a commandline argument
- by a configuration file found relative to the current directory
- by a configuration file found relative to the home directory
-- by a configuration file found below /etc
+- by a configuration file found below `/` etc
To allow such keys to exist in parallel, Elektra uses namespaces.
@@ -21,17 +21,17 @@ A namespace has following properties:
configuration source. For example files from the `user` namespace
are from the users home directory, **even if** an absolute configuration
file name was used.
-- ksLookup() uses multiple namespaces in a specific default order unless
+- `ksLookup()` uses multiple namespaces in a specific default order unless
specified otherwise (cascading lookup)
Following parts of Elektra source code are affected by namespaces:
-- the key name validation in keySetName()
-- keyGetNamespace() which enumerates all namespaces
-- _Backend and split.c for correct distribution to plugins (note that
+- the key name validation in `keySetName()`
+- `keyGetNamespace()` which enumerates all namespaces
+- `_Backend` and `split.c` for correct distribution to plugins (note that
not all namespaces actually are distributed to configuration files)
-- mount.c for cascading and root backends
+- `mount.c` for cascading and root backends
- and of course many unit tests
In the rest of this document all currently available namespaces in the default order
@@ -43,7 +43,7 @@ are described.
Unlike the other namespaces, the specification namespace does not
contain values of the keys, but instead metadata as described in
-[METADATA.ini](/doc/METADATA.ini).
+[`METADATA.ini`](/doc/METADATA.ini).
When a cascading key is looked up, keys from the spec-namespace are
the first to be searched. When a spec-key is found, the rest of the
@@ -66,7 +66,7 @@ are written in different syntax than the configuration files.
## proc
-Derived from the process (e.g. by parsing /proc/self or by arguments passed
+Derived from the process (e.g. by parsing `/proc/self` or by arguments passed
from the main method):
- program name
@@ -90,14 +90,14 @@ Note that Elektra only supports a single special directory per KDB
instance. Start a new KDB instance if you need different special
directories for different parts of your application.
How to change the directory may be different dependent on the resolver,
-e.g. by using chdir or by setting the environment variable PWD.
+e.g. by using chdir or by setting the environment variable `PWD`.
## user
On multi-user operating systems obviously every user wants her/his own
configuration. The user configuration is located in the users home
-directory typically below the folder KDB_DB_USER.
+directory typically below the folder `KDB_DB_USER.`
Other paths below the home directory are possible too (absolute path
for resolver).
@@ -105,15 +105,15 @@ Note that Elektra only supports a user directory per KDB
instance. Start a new KDB instance if you need different user
configuration for different parts of your application.
How to change the user may be different dependent on the resolver,
-e.g. by seteuid() or by environment variables like HOME, USER
+e.g. by `seteuid()` or by environment variables like `HOME`, `USER`
## system
The system configuration is the same for every chroot.
-The configuration is typically located below KDB_DB_SYSTEM.
-Other absolute paths, e.g. below /opt or /usr/local/etc are possible
+The configuration is typically located below `KDB_DB_SYSTEM`.
+Other absolute paths, e.g. below `/opt` or `/usr/local/etc` are possible
too.
