[Syncevolution-issues] [Bug 690] New: documentation: single source of all usage info

http://bugzilla.meego.com/show_bug.cgi?id=690 Summary: documentation: single source of all usage info Classification: MeeGo Projects Product: SyncEvolution Version: unspecified Platform: Netbook OS/Version: IA Status: ASSIGNED Severity: enhancement Priority: Low Component: SyncEvolution AssignedTo: syncevolution-bugs(a)meego.bugs ReportedBy: jingke.zhang(a)intel.com QAContact: jingke.zhang(a)intel.com CC: syncevolution-bugs(a)meego.bugs, syncevolution-default-bugs(a)meego.bugs Estimated Hours: 0.0 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. -- Configure bugmail: http://bugzilla.meego.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are watching the assignee of the bug. You are watching someone on the CC list of the bug.