---- Reported by jingke.zhang@intel.com 2010-04-13 02:10:04 +0000 ----

This is from http://bugzilla.moblin.org/show_bug.cgi?id=5462

Keeping separate chunks of documentation in sync is an ongoing effort. Perhaps
we can simplify that task by keeping a single set of source files and generate
all other documentation from it automatically.

The documentation that would be nice to have is:
* README: plain text, the file that is currently maintained in git
* man pages for syncevolution, synccompare, sync-ui: doesn't exist at the
moment
* the "Usage" page on syncevolution.org for the command line

As a first step (BMO#4633) the docs which have already diverged need to be
merged again. Then we need a single source format and corresponding make rules
which will generate the rest.

A suitable format is Perl POD. It can be converted to plain text, roff/man and
HTML, the later in a way such that it can be copied directly into Drupal, the
engine behind syncevolution.org.

It creates no unreasonable build dependencies either because Perl can be taken
for granted.



---- Additional Comments From patrick.ohly@intel.com 2010-04-28 00:08:03 +0000 ----

*** https://bugs.meego.com/show_bug.cgi?id=686 has been marked as a duplicate of this bug. ***



---- Additional Comments From patrick.ohly@intel.com 2010-05-10 07:37:36 +0000 ----

Implemented for SyncEvolution 1.0:
* README.rst in reStructuredText format
* conversion to HTML and man page as part of build

Todo for 1.0:
* copy final Usage page to http://syncevolution.org/documentation/syncevolution-usage

Todo later:
* replace builtin --help text with the right part of README.rst



---- Additional Comments From jingke.zhang@intel.com 2010-06-01 01:13:07 +0000 ----

With syncevolution-0.9.99.23, I noticed the fix for this issue in package changelog (part of fix?). And by my checking, the /usr/share/syncevolution/README file was re-structed with new pattern. 

Do we finish all the re-write? Shall I close this issue? Thanks!



---- Additional Comments From patrick.ohly@intel.com 2010-06-01 06:15:58 +0000 ----

There's still one open part, please don't close:

* replace builtin --help text with the right part of README.rst



---- Additional Comments From patrick.ohly@intel.com 2010-06-30 08:44:16 +0000 ----

Tentative patch in "pohly" branch, asked for comment in [SyncEvolution] updating documentation, part II (MBC #690).



---- Additional Comments From patrick.ohly@intel.com 2010-07-12 09:38:20 +0000 ----

(In reply to comment #5)
> Tentative patch in "pohly" branch, asked for comment in [SyncEvolution]
> updating documentation, part II (MBC #690).  

Merged into master.



--- Bug imported by patrick.ohly@gmx.de 2012-07-29 20:36 UTC  ---

This bug was previously known as _bug_ 690 at https://bugs.meego.com/show_bug.cgi?id=690