Update the configuration file documentation
authorSamuel Ortiz <sameo@linux.intel.com>
Mon, 7 Jun 2010 15:03:13 +0000 (17:03 +0200)
committerSamuel Ortiz <sameo@linux.intel.com>
Mon, 7 Jun 2010 15:03:13 +0000 (17:03 +0200)
The configuration file names should be *.config.

doc/config-format.txt

index bc5a5c189847cb4f91c81254fdd8c7215c24feaa..48b6453de4fb512f161a61d3bb96809ea86d7a04 100644 (file)
@@ -3,7 +3,8 @@ 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/.
+to /var/lib/connman/. Configuration file names should follow the *.config
+pattern.
 Those configuration files are text files with a simple format and we typically
 have one file per provisioned network.
 
@@ -47,8 +48,10 @@ Example
 
 This is a configuration file for a network providing both EAP-TLS and
 EAP-PEAP services.
-The respective SSIDs are tls_ssid and peap_ssid.
+The respective SSIDs are tls_ssid and peap_ssid and the file name is
+example.config.
 
+example@example:[~]$ cat /var/lib/connman/example.config
 [global]
 Name = Example
 Description = Example network configuration