Bug 30930 - incomplete documentation
: incomplete documentation
Status: CLOSED FIXED
: Sisyphus
(All bugs in Sisyphus/ghc7.6.1-flow2dot)
: unstable
: all Linux
: P3 major
Assigned To:
:
:
:
:
:
  Show dependency tree
 
Reported: 2015-04-08 19:25 by
Modified: 2015-04-25 05:26 (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2015-04-08 19:25:10
ghc7.6.1-flow2dot-0.9.0.3-alt2

file:///usr/share/doc/ghc7.6.1-flow2dot-0.9.0.3/html/index.html says:

Generates sequence diagrams from textual descriptions with help of Graphviz
graph drawing tool. Check out
http://adept.linux.kiev.ua:8080/repos/flow2dot/sample.flow (source) and
http://adept.linux.kiev.ua:8080/repos/flow2dot/sample.png (output). 

But the links have rotten.

A programmer can't understand what it does because the examples are absent.

The examples should be packaged together with the library.
------- Comment #1 From 2015-04-08 19:27:04 -------
Luckily, a sample is in the sources:

http://git.altlinux.org/people/mithraen/packages/?p=ghc7.6.1-flow2dot.git;a=blob;f=flow2dot/sample.flow;h=419707f09f1ad12d88eceed6ea43cc33424ae54c;hb=baba23f01e70982c768486e560f2c3186dce1c0f

Just we could package it and use it for the documentation.
------- Comment #2 From 2015-04-10 18:14:10 -------
ghc7.6.1-flow2dot-0.9.0.3-alt3 -> sisyphus:

* Fri Apr 10 2015 Denis Smirnov <mithraen@altlinux> 0.9.0.3-alt3
- add sample (ALT 30930)
------- Comment #3 From 2015-04-24 16:38:55 -------
(В ответ на комментарий №2)
> ghc7.6.1-flow2dot-0.9.0.3-alt3 -> sisyphus:
> 
> * Fri Apr 10 2015 Denis Smirnov <mithraen@altlinux> 0.9.0.3-alt3
> - add sample (ALT 30930)

No, the sample hasn't been included, despite
http://git.altlinux.org/people/mithraen/packages/?p=ghc7.6.1-flow2dot.git;a=commitdiff;h=95ef0df5c49e45079c41a4f770d8fc5e73213b37
:

[imz@z ~]$ rpm -q ghc7.6.1-flow2dot 
ghc7.6.1-flow2dot-0.9.0.3-alt3
[imz@z ~]$ rpm -q ghc7.6.1-flow2dot -l | fgrep sample
[imz@z ~]$
------- Comment #4 From 2015-04-25 05:26:31 -------
flow2dot binary and sample.flow was packaged in a flow2dot subpackage:

$ rpm -ql flow2dot
/usr/bin/flow2dot
/usr/share/doc/flow2dot-0.9.0.3
/usr/share/doc/flow2dot-0.9.0.3/LICENSE
/usr/share/doc/flow2dot-0.9.0.3/README
/usr/share/doc/flow2dot-0.9.0.3/sample.flow