From ba322d8aa4199ac6ad19376c3f532da94d3a51ae Mon Sep 17 00:00:00 2001 From: Jussi Laakkonen Date: Wed, 10 Apr 2024 17:50:38 +0300 Subject: [PATCH] doc: Update config file storage paths descriptions [doc] Update config file storage paths descriptions. JB#61888 Change the description to detail the default build time set values for both StorageRoot and UserStorage paths. Change the default UserStorage to be ".config" in Makefile.am. The paths are read from configuration files on both connman and connman-vpn. --- connman/Makefile.am | 5 +++-- connman/doc/config-format.txt | 16 +++++++++++----- connman/doc/vpn-config-format.txt | 17 ++++++++++++----- 3 files changed, 26 insertions(+), 12 deletions(-) diff --git a/connman/Makefile.am b/connman/Makefile.am index 32c04d6cf..63f5d11df 100644 --- a/connman/Makefile.am +++ b/connman/Makefile.am @@ -228,8 +228,9 @@ scriptdir = $(libdir)/connman/scripts storageroot = $(localstatedir)/lib -# Path in users' home dir to use as storage dir -userstorage = ".local/share/system/privileged" +# Path in users' home dir to use as a storage dir. connman/connman-vpn will +# be created when omitted. +userstorage = ".config" configdir = ${sysconfdir}/connman diff --git a/connman/doc/config-format.txt b/connman/doc/config-format.txt index ed3123aad..f752f9a2c 100644 --- a/connman/doc/config-format.txt +++ b/connman/doc/config-format.txt @@ -3,11 +3,17 @@ Connman configuration file format Connman uses configuration files to provision existing services. Connman will be looking for its configuration files at STORAGEDIR which by default points -to /var/lib/connman/. Configuration file names must not include other -characters than letters or numbers and must have a .config suffix. -Those configuration files are text files with a simple key-value pair format, -organized into sections. Values do not comprise leading or trailing whitespace. -We typically have one file per provisioned network. +to /var/lib/connman/. This can be overridden with a value "StorageRoot" in the +main configuration file, typically in /etc/connman/main.conf. With multiuser +support enabled, the user-specific configuration data is stored by default into +users' home at $HOME/.config and can be overridden with a value "UserStorage" +in the configuration file. + +Configuration file names must not include other characters than letters or +numbers and must have a .config suffix. Those configuration files are text +files with a simple key-value pair format, organized into sections. Values do +not comprise leading or trailing whitespace. We typically have one file per +provisioned network. If the config file is removed, then Connman tries to remove the provisioned services. If an individual service inside a config is removed, diff --git a/connman/doc/vpn-config-format.txt b/connman/doc/vpn-config-format.txt index aa0099824..676407d7b 100644 --- a/connman/doc/vpn-config-format.txt +++ b/connman/doc/vpn-config-format.txt @@ -3,11 +3,18 @@ Connman configuration file format for VPN Connman VPN uses configuration files to provision existing providers. vpnd will be looking for its configuration files at VPN_STORAGEDIR -which by default points to /var/lib/connman-vpn. Configuration file names -must not include other characters than letters or numbers and must have -a .config suffix. Those configuration files are text files with a simple -key-value pair format organized into sections. Values do not comprise leading -trailing whitespace. We typically have one file per provisioned network. +which by default points to /var/lib/connman-vpn. This can be overridden with a +value "StorageRoot" in the connman-vpn configuration file, typically in +/etc/connman/connman-vpn.conf. With multiuser support enabled, the +user-specific configuration data is stored by default into users' home at +$HOME/.config and can be overridden with a value "UserStorage" in the +configuration file. + +Configuration file names must not include other characters than letters or +numbers and must have a .config suffix. Those configuration files are text +files with a simple key-value pair format organized into sections. Values do +not comprise leading or trailing whitespace. We typically have one file per +provisioned network. If the config file is removed, then vpnd tries to remove the provisioned service. If an individual service entry inside a config is removed,