sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-04-27 14:57:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Formatting fixes

Browse source
This commit is contained in:
Markus Unterwaditzer 2014-05-21 18:53:09 +02:00
parent 811f378ece
commit cae0abe8c1
4 changed files with 42 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/api.rst
View file

@ -11,17 +11,19 @@ General Section
--------------- ---------------
:: ::
[general] [general]
status_path = ... status_path = ...
#processes = 0 #processes = 0
- ``status_path``: A directory where vdirsyncer will store metadata for the
- ``status_path``: A directory where vdirsyncer will store metadata for the
next sync. The data is needed to determine whether a new item means it has next sync. The data is needed to determine whether a new item means it has
been added on one side or deleted on the other. been added on one side or deleted on the other.
- ``processes``: Optional, defines the amount of maximal connections to use - ``processes``: Optional, defines the amount of maximal connections to use for
for syncing. By default there is no limit, which means vdirsyncer will try syncing. By default there is no limit, which means vdirsyncer will try to
to open a connection for each collection to be synced. The value ``0`` is open a connection for each collection to be synced. The value ``0`` is
ignored. Setting this to ``1`` will only synchronize one collection at a ignored. Setting this to ``1`` will only synchronize one collection at a
time. time.
@ -36,17 +38,18 @@ Pair Section
------------ ------------
:: ::
[pair pair_name] [pair pair_name]
a = ... a = ...
b = ... b = ...
#conflict_resolution = ... #conflict_resolution = ...
- ``a`` and ``b`` reference the storages to sync by their names. - ``a`` and ``b`` reference the storages to sync by their names.
- ``conflict_resolution``: Optional, define how conflicts should be handled. - ``conflict_resolution``: Optional, define how conflicts should be handled. A
A conflict occurs when one item changed on both sides since the last sync. conflict occurs when one item changed on both sides since the last sync.
Valid values are ``a wins`` and ``b wins``. By default, vdirsyncer will Valid values are ``a wins`` and ``b wins``. By default, vdirsyncer will show
show an error and abort the synchronization. an error and abort the synchronization.
.. _storage_config: .. _storage_config:
@ -54,12 +57,13 @@ Storage Section
--------------- ---------------
:: ::
[storage storage_name] [storage storage_name]
type = ... type = ...
- ``type`` defines which kind of storage is defined. See :ref:`storages`. - ``type`` defines which kind of storage is defined. See :ref:`storages`.
- Any further parameters are passed on to the storage class. - Any further parameters are passed on to the storage class.
.. _storages: .. _storages:

4
docs/troubleshooting.rst
View file

@ -2,7 +2,7 @@
Troubleshooting Troubleshooting
=============== ===============
- **[Errno 185090050] _ssl.c:343: error:0B084002:x509 certificate - **[Errno 185090050] _ssl.c:343: error:0B084002:x509 certificate
routines:X509_load_cert_crl_file:system lib** routines:X509_load_cert_crl_file:system lib**
vdirsyncer cannot find the path to your certificate bundle, you need to vdirsyncer cannot find the path to your certificate bundle, you need to
@ -10,7 +10,7 @@ Troubleshooting
verify = /usr/share/ca-certificates/cacert.org/cacert.org_root.crt verify = /usr/share/ca-certificates/cacert.org/cacert.org_root.crt
- **During sync an error occurs: TypeError: request() got an unexpected keyword - **During sync an error occurs: TypeError: request() got an unexpected keyword
argument 'verify'** argument 'verify'**
You need to update your version of requests. You need to update your version of requests.

10
docs/tutorial.rst
View file

@ -5,11 +5,11 @@ Tutorial
Installation Installation
============ ============
- Make sure you have Python 2.7+ or Python 3.3+ installed. - Make sure you have Python 2.7+ or Python 3.3+ installed.
- ``pip install --user vdirsyncer``. - ``pip install --user vdirsyncer``.
- Check if the ``vdirsyncer`` command is available. - Check if the ``vdirsyncer`` command is available.
Configuration Configuration
============= =============
@ -69,10 +69,10 @@ But what if we want to synchronize multiple addressbooks from the same server?
Of course we could create new pairs and storages for each addressbook, but that Of course we could create new pairs and storages for each addressbook, but that
is very tedious to do. Instead we will use a shortcut: is very tedious to do. Instead we will use a shortcut:
- Remove the last segment from the URL, so that it ends with ``.../bob/`` - Remove the last segment from the URL, so that it ends with ``.../bob/``
instead of ``.../bob/default/``. instead of ``.../bob/default/``.
- Add the following line to the *pair* section:: - Add the following line to the *pair* section::
[pair my_contacts] [pair my_contacts]
... ...

1
vdirsyncer/storage/http.py
View file

@ -60,7 +60,6 @@ class HttpStorage(Storage):
A simple example:: A simple example::
# HTTP CALENDAR
[pair holidays] [pair holidays]
a = holidays_local a = holidays_local
b = holidays_remote b = holidays_remote