source: TODO @ 1b751b

Revision 1b751b, 3.3 KB checked in by Jaromil <jaromil@…>, 21 months ago (diff)

autoconf fixes for documentation

doxygen generation and installation
documentation files installation
cleanup of generated documentation

  • Property mode set to 100644
Line 
1
2Frei0r TODO
3~~~~~~~~~~~
4
5Table of Contents
6=================
7Welcome hackers!
8Port existing code
9Bugfixes
10    Test suite
11    Null parameters
12Spec Update
13Documentation
14    Screenshots
15    Trac spam
16
17
18Welcome hackers!
19~~~~~~~~~~~~~~~~~
20
21The Frei0r mailinglist is the first step to get in touch with us: the
22one we use is [frei0r-devel] and it has [public archives] that are also
23[searchable and indexed] online.
24
25The bugtracker we are currently using  is [the Piksel trac], have a look
26there and, if  you know how to  report a bug, please open  a new issue
27and give it as many details as you can.
28
29Here below are outlined some open issues in the development flow, they
30range   from  /bugfixing/   tasks  to   /specification   updates/  and
31/documentation/.
32
33
34[frei0r-devel]: https://piksel.no/mailman/listinfo/frei0r-devel
35[public archives]: http://piksel.no/pipermail/frei0r-devel/
36[searchable and indexed]: http://blog.gmane.org/gmane.comp.video.frei0r.devel
37[the Piksel trac]: http://www.piksel.no/projects/frei0r/report
38
39Port existing code
40~~~~~~~~~~~~~~~~~~~
41
42Porting  new Effects  from existing  collections should  be  easy, for
43instance there  is a lot of code  to be ported from  [EffecTV], the [Demo Effects Collection],  [Pete's plugins] and  the XScreensavers
 let  us if
44you engage  the task, it can  be fun and  not so difficult if  you are
45just learning how to program in C or C++.
46
47
48[EffecTV]: http://effectv.sf.net/
49[Demo Effects Collection]: http://demo-effects.sourceforge.net/
50[Pete's plugins]: ftp://ftp.dyne.org/freej/plugins/petespluginslinux_070114.tar.gz
51
52Bugfixes
53~~~~~~~~~
54
55We should remove from installation any plugins which casuse a crash or
56data loss - and if we want them back we'd better fix them, in any case
57we can't allow distribution of  plugins that can potentially crash the
58host.
59
60This is an  old issue with dynamically loaded  objects: if they crash,
61they'll crash the  host application loading them!  one  reason why JWZ
62made XScreensavers share an X11 /back-display/...
63
64TODO Test suite
65================
66
67Develop  a test  suite  for frei0r  plugins (/scaffolding/  technique)
68which  can  be run  to  generate reports  on  reliability.
69
70TODO Null parameters
71=====================
72
73Fix  plugins which do  not set  parameters to  a default  value inside
74*f0r_init()*  - this crashes  some applications  as often  reported in
75bugreports.
76
77Spec Update
78~~~~~~~~~~~~
79
80We sometimes need  to review the Frei0r specification  and confront it
81with new issues coming up. It might be also useful to confront it with
82the  specification  drafted  in   [LiViDO],  which  provides  a  broader
83case-study, and other standards adopted in [GStreamer].
84
85
86[LiViDO]: http://livido.dyne.org/codedoc/
87[GStreamer]: http://gstreamer.freedesktop.org/documentation/
88
89Documentation
90~~~~~~~~~~~~~~
91
92Screenshots
93============
94
95A Gallery of filters is  already being generated, but not yet complete
96with screenshots. Right now [FreeJ]  is being used with scripts to parse
97plugin contents and render them into a webpage, still what are missing
98are screenshots or maybe short video renderings of plugins in action.
99
100
101[FreeJ]: http://freej.dyne.org
102
103TODO Trac spam
104===============
105
106We should fix the trac on piksel.org, install a new bugtracker like
107[flyspray] or use the mantis already up at [bugs.dyne.org].
108
109
110[flyspray]: http://flyspray.org
111[bugs.dyne.org]: http://bugs.dyne.org
112
Note: See TracBrowser for help on using the repository browser.