proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-07 11:25:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

lib: add some quick explainers for path vars

Browse Source 
It's not immediately obvious what exactly the `frr_*dir` variables
exported from lib/libfrr.c are for.  Add a little text each to clarify.

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
This commit is contained in:
David Lamparter 2024-07-11 05:38:36 +02:00
parent 54b72028c6
commit 6ade526f7b
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
lib/libfrr.h
View File

@ -222,10 +222,39 @@ extern void frr_fini(void);
extern char config_default[512]; extern char config_default[512];
extern char frr_zclientpath[512]; extern char frr_zclientpath[512];
/* refer to lib/config_paths.h (generated during ./configure) for build config
* values of the following:
*/
/* sysconfdir is generally /etc/frr/, some BSDs may use /usr/local/etc/frr/.
* Will NOT include "pathspace" (namespace) suffix from -N. (libfrr.c handles
* pathspace'ing config files.) Has a slash at the end for "historical"
* reasons.
*/
extern const char frr_sysconfdir[]; extern const char frr_sysconfdir[];
/* runstatedir is *ephemeral* across reboots. It may either be a ramdisk,
* or be wiped during boot. Use only for pid files, sockets, and the like,
* not state. Commonly /run/frr or /var/run/frr.
* Will include "pathspace" (namespace) suffix from -N.
*/
extern char frr_runstatedir[256]; extern char frr_runstatedir[256];
/* libstatedir is *persistent*. It's the place to put state like sequence
* numbers or databases. Commonly /var/lib/frr.
* Will include "pathspace" (namespace) suffix from -N.
*/
extern char frr_libstatedir[256]; extern char frr_libstatedir[256];
/* moduledir is something along the lines of /usr/lib/frr/modules or
* /usr/lib/x86_64-linux-gnu/frr/modules. It is not guaranteed to be a
* subdirectory of the directory that the daemon binaries reside in. (e.g.
* the "x86_64-linux-gnu" component will be absent from daemon paths.)
*/
extern const char frr_moduledir[]; extern const char frr_moduledir[];
/* scriptdir is for Lua scripts, generally ${frr_sysconfdir}/scripts */
extern const char frr_scriptdir[]; extern const char frr_scriptdir[];
extern char frr_protoname[]; extern char frr_protoname[];