From e08e266cbecf70b238c4dedc0b6277deee64035a Mon Sep 17 00:00:00 2001 From: Julian Mehne Date: Wed, 30 Apr 2014 19:52:04 +0200 Subject: [PATCH 1/2] Clarify the purpose of `pair` definitions in the config file. --- example.cfg | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/example.cfg b/example.cfg index 4f62ecc..f50ba2e 100644 --- a/example.cfg +++ b/example.cfg @@ -14,7 +14,9 @@ status_path = ~/.vdirsyncer/status/ # CONTACTS [pair bob_contacts] -# Similar to accounts in OfflineIMAP. +# A `[pair ]` block defines two storages `a` and `b` that should be +# synchronized. The definition of these storages follows in `[storage ]` +# blocks. This is similar to accounts in OfflineIMAP. a = bob_contacts_local b = bob_contacts_remote From 60aeaa7a17d87afc630ac9b9f8024a89dfc2e6da Mon Sep 17 00:00:00 2001 From: Julian Mehne Date: Wed, 30 Apr 2014 19:55:01 +0200 Subject: [PATCH 2/2] Try to make the explanation of collections more obvious. --- example.cfg | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/example.cfg b/example.cfg index f50ba2e..524cb62 100644 --- a/example.cfg +++ b/example.cfg @@ -20,18 +20,22 @@ status_path = ~/.vdirsyncer/status/ a = bob_contacts_local b = bob_contacts_remote -# collections are addressbooks, calendars etc to be synced. The comma-separated -# values in this parameter are representing subdirectories, are added as URL -# segment or similar. +# If you want to synchronize several addressbooks, calendars etc that share +# the same storage location and differ only in a suffix to this location +# (i.e., a subdirectory) you can use collections. The comma-separated values +# in this parameter represent these subdirectories and are added as URL +# segments or similar. -# In this example, it means that +# Together with the definition of the following two `[storage]` blocks below +# in this example it means that # - https://owncloud.example.com/remote.php/carddav/addressbooks/bob/default/ # will get synced with ~/.contacts/default/ # - https://owncloud.example.com/remote.php/carddav/addressbooks/bob/work/ # will get synced with ~/.contacts/work/ -# Omitting this parameter implies that the given path and URL are already -# pointing to a collection each. +# Omitting this parameter implies that the given path and URL in the +# corresponding `[storage ]` blocks are already pointing to a +# collection each. collections = default,work # conflict_resolution = None # abort when collisions occur (default)