Merge pull request #15243 from opensourcerouting/autoconf-dir-mess

*: fix a pile of directory and/or state retention related issues

19 files changed, 48 insertions, 48 deletions

diff --git a/doc/developer/building-frr-for-centos6.rst b/doc/developer/building-frr-for-centos6.rst
index fb796e491e..3531162360 100644
--- a/doc/developer/building-frr-for-centos6.rst
+++ b/doc/developer/building-frr-for-centos6.rst
@@ -161,10 +161,8 @@ an example.)
     ./configure \
         --bindir=/usr/bin \
         --sbindir=/usr/lib/frr \
-        --sysconfdir=/etc/frr \
         --libdir=/usr/lib/frr \
         --libexecdir=/usr/lib/frr \
-        --localstatedir=/var/run/frr \
         --with-moduledir=/usr/lib/frr/modules \
         --disable-pimd \
         --enable-snmp=agentx \
diff --git a/doc/developer/building-frr-for-centos7.rst b/doc/developer/building-frr-for-centos7.rst
index e6da830194..eabf515d2e 100644
--- a/doc/developer/building-frr-for-centos7.rst
+++ b/doc/developer/building-frr-for-centos7.rst
@@ -58,10 +58,8 @@ an example.)
     ./configure \
         --bindir=/usr/bin \
         --sbindir=/usr/lib/frr \
-        --sysconfdir=/etc/frr \
         --libdir=/usr/lib/frr \
         --libexecdir=/usr/lib/frr \
-        --localstatedir=/var/run/frr \
         --with-moduledir=/usr/lib/frr/modules \
         --enable-snmp=agentx \
         --enable-multipath=64 \
diff --git a/doc/developer/building-frr-for-centos8.rst b/doc/developer/building-frr-for-centos8.rst
index 6d18e7be93..2d514ead1e 100644
--- a/doc/developer/building-frr-for-centos8.rst
+++ b/doc/developer/building-frr-for-centos8.rst
@@ -52,10 +52,8 @@ an example.)
     ./configure \
         --bindir=/usr/bin \
         --sbindir=/usr/lib/frr \
-        --sysconfdir=/etc/frr \
         --libdir=/usr/lib/frr \
         --libexecdir=/usr/lib/frr \
-        --localstatedir=/var/run/frr \
         --with-moduledir=/usr/lib/frr/modules \
         --enable-snmp=agentx \
         --enable-multipath=64 \
diff --git a/doc/developer/building-frr-for-debian12.rst b/doc/developer/building-frr-for-debian12.rst
index ca882eedbc..06bc18c252 100644
--- a/doc/developer/building-frr-for-debian12.rst
+++ b/doc/developer/building-frr-for-debian12.rst
@@ -47,9 +47,9 @@ an example.)
     cd frr
     ./bootstrap.sh
     ./configure \
-        --localstatedir=/var/opt/frr \
+        --sysconfdir=/etc \
+        --localstatedir=/var \
         --sbindir=/usr/lib/frr \
-        --sysconfdir=/etc/frr \
         --enable-multipath=64 \
         --enable-user=frr \
         --enable-group=frr \
diff --git a/doc/developer/building-frr-for-debian8.rst b/doc/developer/building-frr-for-debian8.rst
index 7071cb660d..fe4eeea601 100644
--- a/doc/developer/building-frr-for-debian8.rst
+++ b/doc/developer/building-frr-for-debian8.rst
@@ -57,9 +57,9 @@ an example.)
     cd frr
     ./bootstrap.sh
     ./configure \
-        --localstatedir=/var/run/frr \
+        --sysconfdir=/etc \
+        --localstatedir=/var \
         --sbindir=/usr/lib/frr \
-        --sysconfdir=/etc/frr \
         --enable-multipath=64 \
         --enable-user=frr \
         --enable-group=frr \
@@ -118,9 +118,9 @@ Troubleshooting
 
 The local state directory must exist and have the correct permissions
 applied for the frrouting daemons to start. In the above ./configure
-example the local state directory is set to /var/run/frr
-(--localstatedir=/var/run/frr) Debian considers /var/run/frr to be
-temporary and this is removed after a reboot.
+example the local state directory is set to ``/var`` such that ``/var/run/frr``
+is used. Debian considers ``/var/run/frr`` to be temporary and this is removed
+after a reboot.
 
 When using a different local state directory you need to create the new
 directory and change the ownership to the frr user, for example:
diff --git a/doc/developer/building-frr-for-debian9.rst b/doc/developer/building-frr-for-debian9.rst
index 1b2f1b933a..a590cf7c74 100644
--- a/doc/developer/building-frr-for-debian9.rst
+++ b/doc/developer/building-frr-for-debian9.rst
@@ -47,9 +47,9 @@ an example.)
     cd frr
     ./bootstrap.sh
     ./configure \
-        --localstatedir=/var/opt/frr \
+        --sysconfdir=/etc \
+        --localstatedir=/var \
         --sbindir=/usr/lib/frr \
-        --sysconfdir=/etc/frr \
         --enable-multipath=64 \
         --enable-user=frr \
         --enable-group=frr \
diff --git a/doc/developer/building-frr-for-freebsd10.rst b/doc/developer/building-frr-for-freebsd10.rst
index 707f1e7033..beefb59a27 100644
--- a/doc/developer/building-frr-for-freebsd10.rst
+++ b/doc/developer/building-frr-for-freebsd10.rst
@@ -60,9 +60,9 @@ an example)
     export LDFLAGS="-L/usr/local/lib"
     export CPPFLAGS="-I/usr/local/include"
     ./configure \
-        --sysconfdir=/usr/local/etc/frr \
+        --sysconfdir=/usr/local/etc \
+        --localstatedir=/var \
         --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
-        --localstatedir=/var/run/frr \
         --prefix=/usr/local \
         --enable-multipath=64 \
         --enable-user=frr \
diff --git a/doc/developer/building-frr-for-freebsd11.rst b/doc/developer/building-frr-for-freebsd11.rst
index af0b72b16d..7c8fb83cfa 100644
--- a/doc/developer/building-frr-for-freebsd11.rst
+++ b/doc/developer/building-frr-for-freebsd11.rst
@@ -65,9 +65,9 @@ an example)
    setenv CPPFLAGS -I/usr/local/include
    ln -s /usr/local/bin/sphinx-build-3.6 /usr/local/bin/sphinx-build
    ./configure \
-       --sysconfdir=/usr/local/etc/frr \
+       --sysconfdir=/usr/local/etc \
+       --localstatedir=/var \
        --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
-       --localstatedir=/var/run/frr \
        --prefix=/usr/local \
        --enable-multipath=64 \
        --enable-user=frr \
diff --git a/doc/developer/building-frr-for-freebsd13.rst b/doc/developer/building-frr-for-freebsd13.rst
index 0bc8277930..86506a9dd9 100644
--- a/doc/developer/building-frr-for-freebsd13.rst
+++ b/doc/developer/building-frr-for-freebsd13.rst
@@ -52,9 +52,9 @@ an example)
    ./bootstrap.sh
    export MAKE=gmake LDFLAGS=-L/usr/local/lib CPPFLAGS=-I/usr/local/include
    ./configure \
-       --sysconfdir=/usr/local/etc/frr \
+       --sysconfdir=/usr/local/etc \
+       --localstatedir=/var \
        --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
-       --localstatedir=/var/run/frr \
        --prefix=/usr/local \
        --enable-multipath=64 \
        --enable-user=frr \
diff --git a/doc/developer/building-frr-for-freebsd14.rst b/doc/developer/building-frr-for-freebsd14.rst
index 3d1fcacf1b..b3fd37aa10 100644
--- a/doc/developer/building-frr-for-freebsd14.rst
+++ b/doc/developer/building-frr-for-freebsd14.rst
@@ -52,9 +52,9 @@ an example)
    ./bootstrap.sh
    export MAKE=gmake LDFLAGS=-L/usr/local/lib CPPFLAGS=-I/usr/local/include
    ./configure \
-       --sysconfdir=/usr/local/etc/frr \
+       --sysconfdir=/usr/local/etc \
+       --localstatedir=/var \
        --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
-       --localstatedir=/var/run/frr \
        --prefix=/usr/local \
        --enable-multipath=64 \
        --enable-user=frr \
diff --git a/doc/developer/building-frr-for-freebsd9.rst b/doc/developer/building-frr-for-freebsd9.rst
index 30332875a0..9f9073d4e2 100644
--- a/doc/developer/building-frr-for-freebsd9.rst
+++ b/doc/developer/building-frr-for-freebsd9.rst
@@ -70,9 +70,9 @@ an example)
     export LDFLAGS="-L/usr/local/lib"
     export CPPFLAGS="-I/usr/local/include"
     ./configure \
-        --sysconfdir=/usr/local/etc/frr \
+        --sysconfdir=/usr/local/etc \
+        --localstatedir=/var \
         --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
-        --localstatedir=/var/run/frr \
         --prefix=/usr/local \
         --enable-multipath=64 \
         --enable-user=frr \
diff --git a/doc/developer/building-frr-for-netbsd6.rst b/doc/developer/building-frr-for-netbsd6.rst
index 8958862fea..77c0e008ef 100644
--- a/doc/developer/building-frr-for-netbsd6.rst
+++ b/doc/developer/building-frr-for-netbsd6.rst
@@ -64,9 +64,9 @@ an example)
     export LDFLAGS="-L/usr/pkg/lib -R/usr/pkg/lib"
     export CPPFLAGS="-I/usr/pkg/include"
     ./configure \
-        --sysconfdir=/usr/pkg/etc/frr \
+        --sysconfdir=/usr/pkg/etc \
+        --localstatedir=/var \
         --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
-        --localstatedir=/var/run/frr \
         --enable-multipath=64 \
         --enable-user=frr \
         --enable-group=frr \
diff --git a/doc/developer/building-frr-for-netbsd7.rst b/doc/developer/building-frr-for-netbsd7.rst
index e751ba338c..abb04a028b 100644
--- a/doc/developer/building-frr-for-netbsd7.rst
+++ b/doc/developer/building-frr-for-netbsd7.rst
@@ -55,9 +55,9 @@ an example)
     export LDFLAGS="-L/usr/pkg/lib -R/usr/pkg/lib"
     export CPPFLAGS="-I/usr/pkg/include"
     ./configure \
-        --sysconfdir=/usr/pkg/etc/frr \
+        --sysconfdir=/usr/pkg/etc \
+        --localstatedir=/var \
         --enable-pkgsrcrcdir=/usr/pkg/share/examples/rc.d \
-        --localstatedir=/var/run/frr \
         --enable-multipath=64 \
         --enable-user=frr \
         --enable-group=frr \
diff --git a/doc/developer/building-frr-for-openbsd6.rst b/doc/developer/building-frr-for-openbsd6.rst
index 00bc2e5f09..6d7f346231 100644
--- a/doc/developer/building-frr-for-openbsd6.rst
+++ b/doc/developer/building-frr-for-openbsd6.rst
@@ -71,8 +71,8 @@ an example)
     export LDFLAGS="-L/usr/local/lib"
     export CPPFLAGS="-I/usr/local/include"
     ./configure \
-        --sysconfdir=/etc/frr \
-        --localstatedir=/var/frr \
+        --sysconfdir=/etc \
+        --localstatedir=/var \
         --enable-multipath=64 \
         --enable-user=_frr \
         --enable-group=_frr \
diff --git a/doc/developer/cross-compiling.rst b/doc/developer/cross-compiling.rst
index 3bf78f7633..af99262c4f 100644
--- a/doc/developer/cross-compiling.rst
+++ b/doc/developer/cross-compiling.rst
@@ -239,9 +239,9 @@ the last thing to actually build is FRR itself:
       --host=${HOST_ARCH} \
       --with-sysroot=/usr/${HOST_ARCH} \
       --with-clippy=./build-clippy/lib/clippy \
-      --sysconfdir=/etc/frr \
+      --sysconfdir=/etc \
+      --localstatedir=/var \
       --sbindir="\${prefix}/lib/frr" \
-      --localstatedir=/var/run/frr \
       --prefix=/usr \
       --enable-user=frr \
       --enable-group=frr \
diff --git a/doc/developer/include-compile.rst b/doc/developer/include-compile.rst
index b98d237e68..49fd6c854c 100644
--- a/doc/developer/include-compile.rst
+++ b/doc/developer/include-compile.rst
@@ -14,8 +14,8 @@ obtained by running ``./configure -h``. The options shown below are examples.
        --sbindir=\${prefix}/lib/frr \
        --libdir=\${prefix}/lib/frr \
        --libexecdir=\${prefix}/lib/frr \
-       --localstatedir=/var/run/frr \
-       --sysconfdir=/etc/frr \
+       --sysconfdir=/etc \
+       --localstatedir=/var \
        --with-moduledir=\${prefix}/lib/frr/modules \
        --enable-configfile-mask=0640 \
        --enable-logfile-mask=0640 \
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
index 2259c7e375..7c65164b0e 100644
--- a/doc/developer/topotests.rst
+++ b/doc/developer/topotests.rst
@@ -113,9 +113,9 @@ If you prefer to manually build FRR, then use the following suggested config:
 
    ./configure \
        --prefix=/usr \
-       --localstatedir=/var/run/frr \
+       --sysconfdir=/etc \
+       --localstatedir=/var \
        --sbindir=/usr/lib/frr \
-       --sysconfdir=/etc/frr \
        --enable-vtysh \
        --enable-pimd \
        --enable-pim6d \
@@ -383,8 +383,9 @@ for ``master`` branch:
    ./bootstrap.sh
    ./configure \
        --enable-address-sanitizer \
-       --prefix=/usr/lib/frr --sysconfdir=/etc/frr \
-       --localstatedir=/var/run/frr \
+       --prefix=/usr/lib/frr \
+       --sysconfdir=/etc \
+       --localstatedir=/var \
        --sbindir=/usr/lib/frr --bindir=/usr/lib/frr \
        --with-moduledir=/usr/lib/frr/modules \
        --enable-multipath=0 --enable-rtadv \
diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index 6915885f45..3ca104a3a9 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -46,9 +46,7 @@ may also be specified (:ref:`common-invocation-options`).
       /usr/lib/frr/bfdd --bfdctl /tmp/bfdd.sock
 
 
-   The default UNIX socket location is:
-
-      #define BFDD_CONTROL_SOCKET "|INSTALL_PREFIX_STATE|/bfdd.sock"
+   The default UNIX socket location is |INSTALL_PREFIX_STATE|/bfdd.sock
 
    This option overrides the location addition that the -N option provides
    to the bfdd.sock
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 \
        ...