mirror of
https://github.com/samsonjs/vdirsyncer.git
synced 2026-03-25 08:55:50 +00:00
Add some docs for read-only storage support
This commit is contained in:
parent
2d348da2f0
commit
783d2b56b3
2 changed files with 19 additions and 10 deletions
23
docs/api.rst
23
docs/api.rst
|
|
@ -75,8 +75,9 @@ Storage Section
|
|||
- ``type`` defines which kind of storage is defined. See :ref:`storages`.
|
||||
|
||||
- ``read_only`` defines whether the storage should be regarded as a read-only
|
||||
storage, defaulting to ``False``. Setting this to ``True`` effectively means
|
||||
synchronization will discard any changes made to the other side.
|
||||
storage. The value ``True`` means synchronization will discard any changes
|
||||
made to the other side. The value ``False`` implies normal 2-way
|
||||
synchronization.
|
||||
|
||||
- Any further parameters are passed on to the storage class.
|
||||
|
||||
|
|
@ -87,12 +88,26 @@ Supported Storages
|
|||
|
||||
.. module:: vdirsyncer.storage
|
||||
|
||||
Read-write storages
|
||||
-------------------
|
||||
|
||||
These storages generally support reading and changing of their items. Their
|
||||
default value for ``read_only`` is ``False``, but can be set to ``True`` if
|
||||
wished.
|
||||
|
||||
.. autoclass:: CaldavStorage
|
||||
|
||||
.. autoclass:: CarddavStorage
|
||||
|
||||
.. autoclass:: FilesystemStorage
|
||||
|
||||
.. autoclass:: HttpStorage
|
||||
|
||||
.. autoclass:: SingleFileStorage
|
||||
|
||||
Read-only storages
|
||||
------------------
|
||||
|
||||
These storages don't support writing of their items, consequently ``read_only``
|
||||
is set to ``True`` by default. Changing ``read_only`` to ``False`` on them
|
||||
might eventually lead to a crash of vdirsyncer when trying to write to them.
|
||||
|
||||
.. autoclass:: HttpStorage
|
||||
|
|
|
|||
|
|
@ -49,12 +49,6 @@ class HttpStorage(Storage):
|
|||
Use a simple ``.ics`` file (or similar) from the web. Usable as ``http`` in
|
||||
the config file.
|
||||
|
||||
.. note::
|
||||
|
||||
This is a read-only storage. If you sync this with
|
||||
read-and-write-storages (such as CalDAV), any changes on the other side
|
||||
will get reverted.
|
||||
|
||||
:param url: URL to the ``.ics`` file.
|
||||
:param username: Username for authentication.
|
||||
:param password: Password for authentication.
|
||||
|
|
|
|||
Loading…
Reference in a new issue