summaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorDavid Lamparter <equinox@opensourcerouting.org>2024-01-25 16:35:29 +0100
committerDavid Lamparter <equinox@opensourcerouting.org>2024-01-27 19:01:19 +0100
commit444bc5e237ca7d95c61f68e3a4951744058c9b64 (patch)
tree5acc910d3c402ac399b6b04111dab09cb8b46624 /doc/user
parentff62df2e4484b9f89fea4ed736006c21f3a797cc (diff)
build: update packaging & docs for dir changes
`--sysconfdir` and `--localstatedir` now align with general autoconf practices. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/installation.rst19
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/user/installation.rst b/doc/user/installation.rst
index 24c6c223e3..efe4787696 100644
--- a/doc/user/installation.rst
+++ b/doc/user/installation.rst
@@ -394,13 +394,20 @@ options to the configuration script.
.. option:: --sysconfdir <dir>
- Look for configuration files in `dir` [`prefix`/etc]. Note that sample
- configuration files will be installed here.
+ Look for configuration files in `dir`/frr [`prefix`/etc]. Note that sample
+ configuration files will be installed here. Should be ``/etc`` unless
+ your platform splits package configuration locations.
.. option:: --localstatedir <dir>
- Configure zebra to use `dir` for local state files, such as pid files and
- unix sockets.
+ Configure base directory for local state. Indirectly controls
+ ``--runstatedir``. Should be ``/var`` in most cases.
+
+.. option:: --runstatedir <dir>
+
+ Configure FRR to use `dir`/frr for local state files, such as pid files and
+ unix sockets. Should be ``/var/run`` (default through ``--localstatedir``)
+ or ``/run`` in most cases.
.. option:: --with-scriptdir <dir>
@@ -579,9 +586,9 @@ the options you chose:
./configure \
--prefix=/usr \
- --localstatedir=/var/run/frr \
+ --sysconfdir=/etc \
+ --localstatedir=/var \
--sbindir=/usr/lib/frr \
- --sysconfdir=/etc/frr \
--enable-pimd \
--enable-watchfrr \
...