diff --git a/docs/when.rst b/docs/when.rst index a4a98de..6045030 100644 --- a/docs/when.rst +++ b/docs/when.rst @@ -2,24 +2,15 @@ When do I need Vdirsyncer? ========================== -Why vdir? -========= - -:doc:`vdir` is a compromise to maintain some compatibility with the CalDAV and -CardDAV protocols, which are supported by :ref:`ownCloud `, -:ref:`Exchange `, :ref:`iCloud ` and many other -services. - -If you don't care about that, you don't need vdirsyncer. However, consider the -following before writing everything into a single text file: - -Why not a simple text file? (todo.txt) --------------------------------------- +Why not Dropbox + todo.txt? +--------------------------- Projects like `todo.txt `_ criticize the complexity of -modern productivity apps, and that rightfully. However, when they're faced with -the question how to synchronize that data across multiple devices, they seemed -to have reached the dead end with their novel idea: "Let's just use Dropbox". +modern productivity apps, and that rightfully. So they set out to create a new, +super-simple, human-readable format, such that vim suffices for viewing the raw +data. However, when they're faced with the question how to synchronize that +data across multiple devices, they seemed to have reached the dead end with +their novel idea: "Let's just use Dropbox". What does file sync software do if both files have changed since the last sync? The answer is to ignore the question, just sync as often as possible, and hope @@ -30,61 +21,36 @@ Merging the two task lists is left to the user. A better idea would've been to use ``git`` to synchronize the ``todo.txt`` file, which is at least able to resolve some basic conflicts. -Why vdirsyncer? -=============== +Why not file sync (Dropbox, git, ...) + vdir? +--------------------------------------------- -Why not Dropbox? ----------------- - -Since :doc:`vdirs ` are just a bunch of files, it is obvious to try -*file synchronization* for synchronizing your data between multiple computers, -such as: +Since :doc:`vdirs ` are just a bunch of files, it is obvious to try *file +synchronization* for synchronizing your data between multiple computers, such +as: * `Syncthing `_ * `Dropbox `_ or one of the gajillion services like it * `unison `_ +* Just ``git`` with a ``sshd``. -If you only need to synchronize things between several desktop machines (and -not e.g. smartphones), using any of those to sync your vdirs will probably fit -your usecase. +The disadvantages of those solutions largely depend on the exact file sync +program chosen: -Since each contact/task/event is contained in its own file, the -chance of sync conflicts is relatively small, but those still happen. -Vdirsyncer doesn't do anything smart if two items have conflicting changes -either, but it could in the future. - -Why not git? ------------- - -If file synchronization software and vdirsyncer are so dumb about sync -conflicts, why not use git then? Why not put your vdirs into a repo, and just -``git commit``, ``git push`` and ``git pull``? It has **many advantages over -both Vdirsyncer and Dropbox**: - -* **Full change history:** If some stupid software deletes all your data, just - revert the commit! - -* **Better at merging in-file conflicts (sometimes):** If you changed the - summary of a task on one computer and the due date on another one, git might - be able to merge these two files to have the new summary *and* the new due - date. +* Like with ``todo.txt``, Dropbox and friends are obviously agnostic/unaware of + the files' contents. If a file has changed on both sides, Dropbox just copies + both versions to both sides. - Vdirsyncer is currently relatively stupid about this (see - :ref:`conflict_resolution`), but in practice, I didn't find its stupidity to - be problematic. + This is a good idea if the user is directly interfacing with the file system + and is able to resolve conflicts themselves. Here it might lead to + errorneous behavior with e.g. ``khal``, since there are now two events with + the same UID. -* **Superior server options:** ``sshd`` is vastly easier to set up and faster - than any DAV-server I've ever seen. Passwordless authentication is also a - huge win, although there are DAV-servers which provide that too. + This point doesn't apply to git: It has very good merging capabilities, + better than what vdirsyncer currently has. -* `Something about data integrity - `_. - You'll quickly notice if your hardware is loosing your files, because git - creates checksums of everything. +* Such a setup doesn't work at all with smartphones. Vdirsyncer, on the other + hand, synchronizes with CardDAV/CalDAV servers, which can be accessed with + e.g. DAVDroid_ or the apps by dmfs_. -Many other CLI programs that need to sync data are based on git, for example -pass_ or ppl_. Those usually hide git behind a convenient CLI interface that at -least autocommits. - -.. _pass: http://passwordstore.org/ -.. _ppl: http://ppladdressbook.org/ +.. _DAVDroid: http://davdroid.bitfire.at/ +.. _dmfs: https://dmfs.org/