Re: [SyncEvolution] improved SyncEvolution README (was: Re: evolution and CalDAV calendar: authentication)
Patrick Ohly <patrick.ohly@...> writes:
On Tue, 2011-10-18 at 08:35 +0200, Patrick Ohly wrote:
Attached the result as plain text, man page and HTML. Code changes were
made against master in the "documentation" branch; the difference
compared to 1.2 is minor (--print-databases is new on the master
branch). My goal is to back-port to the 1.2 branch.
Stephan, does it make more sense now? It would be very useful to go
through this carefully and report all parts which seem odd or are
inconsistent. For someone who has written the whole thing it is
sometimes hard to spot those.
From the commit:
documentation: added glossary and command line conventions sections,
improved
listing of properties
The README.rst now introduces some terms in a glossary directly after
the synopsis. The way how config, sources and properties are used on
the command line are also defined first in their own section, instead
of introducing that further down as part of the options.
The output of "--sync/source-property ?" was changed:
- now it includes information about aliases, default values
and sharing state (useful by itself)
- follows reStructured Text format and thus can be embedded
directly inside the README.rst
Hi Patrick,
Sorry for my late reply. Yes, it definitely makes more sense and I think it's a
great improvement of the documentation. I've read through it and I really have a
better picture of how things work now. I'm looking forward to tweak my
configuration of syncevolution a bit ;-) Maybe I come back with some questions
later - but I think most of it has been clearified. Thank you!
kind regards,
stephan