benn/lumiera_documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
lumiera_documentation/doc/devel/rfc/DevelopmentFramework.txt

189 lines
7 KiB
Text
Raw Normal View History

Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Design Process : Development Framework
======================================
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
[options="autowidth"]
|====================================
|*State* | _Final_
|*Date* | _2007-06-08_
clean-up: re-classify essential RfCs The RfC documents were written to complement discussions of the Lumiera developers; yet since the time where ''Ichthyo'' is working basically alone on the project, this kind of discussions have ceased. During the following years, some ideas promoted by the existing RfC documents became rather detached from the actual state of development in the code base. Many of the existing RfC documents require some commentary to place them into context, and some of the decisions taken in the early stage of the project should be **re-assessed**. This includes the decision to reject some proposals, which initially might have seemed desirable, yet could not be reconciled with the understanding of the matter and topic in question, as was gained through the ongoing analysis and development.
2025-10-05 02:02:22 +02:00
|*Proposed by* | Cehteh
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
|====================================
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Development Framework
---------------------
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
Here we collect how the tree/repository will be set up and which tools are
needed/required for working on lumiera.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Description
~~~~~~~~~~~
.Tools required:
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
* Unix like shell environment with standard tools
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
* we don't require a specific linux distribution
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
* Git 1.5.3 (not out yet, but really soon, we want submodules support)
* GNU toolchain, autoconf/automake (maybe SCons or something else?)
* Bouml (version case unresolved)
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
.Tools suggested:
* doxygen
Tasks
^^^^^
clean-up: re-classify essential RfCs The RfC documents were written to complement discussions of the Lumiera developers; yet since the time where ''Ichthyo'' is working basically alone on the project, this kind of discussions have ceased. During the following years, some ideas promoted by the existing RfC documents became rather detached from the actual state of development in the code base. Many of the existing RfC documents require some commentary to place them into context, and some of the decisions taken in the early stage of the project should be **re-assessed**. This includes the decision to reject some proposals, which initially might have seemed desirable, yet could not be reconciled with the understanding of the matter and topic in question, as was gained through the ongoing analysis and development.
2025-10-05 02:02:22 +02:00
* _Cehteh_ will setup a initial repository
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
(see -> link:{rfc}/RepositorySetup.html[RfC: proposed repository structure])
* ichthyo has setup a debian-APT-depot at 'deb/ichthyostega.de' and will
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
add backport packages there if necessary so the debian-people can stay near
Etch/stable in the next time
clean-up: re-classify essential RfCs The RfC documents were written to complement discussions of the Lumiera developers; yet since the time where ''Ichthyo'' is working basically alone on the project, this kind of discussions have ceased. During the following years, some ideas promoted by the existing RfC documents became rather detached from the actual state of development in the code base. Many of the existing RfC documents require some commentary to place them into context, and some of the decisions taken in the early stage of the project should be **re-assessed**. This includes the decision to reject some proposals, which initially might have seemed desirable, yet could not be reconciled with the understanding of the matter and topic in question, as was gained through the ongoing analysis and development.
2025-10-05 02:02:22 +02:00
* _Ichthyo_ volunteers to get the new source into a debian package structure from
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
start (same as the current cinelerra is)
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
.And for later:
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
* decide on a Unit Test framework
(see -> link:rfc/UnitTestsPython.html[RfC Unit-Tests])
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
* can we get some continuous integration running somewhere (nightly builds,
testsuite)?
* find a viable toolchain for writing more formal documentation.
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
ReStructured Text, Docbook etc?
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Cons
^^^^
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
* Git submodules are just not usable yet; we need to come along with one
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
monolitic large project until they are available.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Alternatives
^^^^^^^^^^^^
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
* use visual studio and .NET [big]#😇#
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Rationale
~~~~~~~~~
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
The project will be tied to a distributed infrastructure based on Git. With recent
Git submodules support it should be easy to let contributors only checkpout/work on
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
parts of the tree (plugins, documentation, i18n, ...). We want to build up a
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
set of maintenance scripts in an `./admin` directory.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
At the moment we go for rather bleeding edge tools, because we want to stay at
Rewrap all RFC's This reverts commit 65bae31de4103abb7d7b6fd004a8315973d3144a. and reprocessed the wrapping. Note that the automatic wrapping is not perfect, some manual fixing by removing some hunks was required.
2010-07-26 02:54:14 +02:00
a given version to avoid incompatibility problems. Later on a version switch
needs agreement/notification by all devs.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Comments
--------
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
I am always in favor of getting the basic project organization and all
Rewrap all RFC's This reverts commit 65bae31de4103abb7d7b6fd004a8315973d3144a. and reprocessed the wrapping. Note that the automatic wrapping is not perfect, some manual fixing by removing some hunks was required.
2010-07-26 02:54:14 +02:00
scripting up and running very early in a project. I would like if the project
would take a rather conservative approach on the required Libs and Tools, so
that finally, when we get into a beta state, we can run/compile on the major
distros without too much pain. I wouldn't completely abandon the idea to target
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
*bsd and osX as well later on.
I would propose to move Doxygen to ``required''. The Idea to use SCons sounds
quite appealing to me at the moment. Besides that, I think this RfC could be
moved to ``Draft''.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
Ichthyostega:: '2007-06-17T00:18:40Z'
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
Moved to Draft. For Developer documentation I would prefer doxygen. For user
documentation we can make a similar/same think like nicolasm did for
cinelerra2, means wiki for edits, git to maintain it, based on gnu texinfo.
Texinfo is quite limiting in its capabilities but it suffices, seeing the
current cin2 docs, i say its rather well done.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
We need to factor out some of the proposals from this page to subpages (scons,
documentation, testing,...)
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
ct:: '2007-06-17T17:27:59Z'
It would really suck if we have to go through the experiences described in the article
https://web.archive.org/web/20060427005516/http://freshmeat.net/articles/view/889/[»Stop the autoconf insanity!«].
I have experienced parts of that
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
in the past. I have only some beginner experience with writing autotoolized
projects (mostly based on trial-and-error) and no experience in any other build
system (such as scons). As such, I still believe that autotools can be
manageable (for me personally) once the initial hurdle of learning is overcome.
I all for Doxygen documentation. Related to documentation are
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
http://splint.org/[Splint: Annotation-Assisted Lightweight Static Checking].
See also http://splint.org/manual/html/appC.html[descriptions of annotations (in comments)].
I suggest
that we consider using such a tool for QA. Like ct said, this should be
Line wrapped all rfc's
2010-07-24 16:48:32 +02:00
discussed in a subpage.
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
I agree with using currently bleeding-edge tools.
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
* _historic remark(Ichthyo):_ who wrote that comment? (neither me nor ct)
We have now a ``compatibility wiki'', finalized this proposal
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
ct:: '2008-03-26T13:43:26Z'
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
clean-up: re-classify essential RfCs The RfC documents were written to complement discussions of the Lumiera developers; yet since the time where ''Ichthyo'' is working basically alone on the project, this kind of discussions have ceased. During the following years, some ideas promoted by the existing RfC documents became rather detached from the actual state of development in the code base. Many of the existing RfC documents require some commentary to place them into context, and some of the decisions taken in the early stage of the project should be **re-assessed**. This includes the decision to reject some proposals, which initially might have seemed desirable, yet could not be reconciled with the understanding of the matter and topic in question, as was gained through the ongoing analysis and development.
2025-10-05 02:02:22 +02:00
''''
....
​
​
​
....
Assessment 2025
~~~~~~~~~~~~~~~
[underline]#In hindsight,# this RfC captures the baseline of our project setup. +
We soon settled upon the following toolchain, which is used up to today:
- One published Git repository per developer, with direct pull / merging; +
history is consolidated eventually into the
link:{rfc}/MasterRepositorySetup.html#historical_remark[»official Lumiera repository«],
which is made accessible at
https://git.lumiera.org/?p=LUMIERA;a=summary[`git://git.lumiera.org/LUMIERA`]
- We never used link:{rfc}/GitSubmoduleTransistion.html#_comments[Git submodules]...
- https://www.scons.org/[SCons] became the primary buildsystem soon,
with Autotools discontinued in 2011
- https://trac.edgewall.org/[Trac] is used as planning- and ticket system.
- API documentation is extracted with https://www.doxygen.nl/[Doxygen]
- Website and documentation pages are generated by
https://asciidoc-py.github.io/[Asciidoc], with source files for
documentation maintained
https://git.lumiera.org/?p=LUMIERA;a=blob;f=doc/index.txt;h=9bc0f11e6fb67588388e7616320b695841571278;hb=20f3252892d5b53a05ecd8aeb571122806baba17[in-tree],
published
https://git.lumiera.org/?p=website;a=blob;f=build_website.sh;h=60b90e18d5732d66566baf2c20a217212a5dcece;hb=aefc91e13a95a3c742dc8143c374ec982e0aa56b[automatically on push].
- A https://classic.tiddlywiki.com/[TiddlyWiki] is used for development notes
- for Unit-Tests, we use our own minimalist
https://git.lumiera.org/?p=LUMIERA;a=blob;f=src/lib/test/run.hpp;h=035633af9bde7a8053bcd304baffc21693dcf031;hb=20f3252892d5b53a05ecd8aeb571122806baba17[Test-runner].
and a
https://git.lumiera.org/?p=LUMIERA;a=blob;f=tests/test.sh;h=8c13810eb475bbacd97c528607e6750f47bb145e;hb=20f3252892d5b53a05ecd8aeb571122806baba17[shell script]
to support definition of test collections.
- A Debian package is maintained with
https://wiki.debian.org/PackagingWithGit[git-buildpackage] and published
in our own DEB depot generated by the
https://wiki.debian.org/DebianRepository/SetupWithReprepro[reprepro tooling].
- UML plays only a marginal role today -- yet in fact we generated our initial class
hierarchy with https://web.archive.org/web/20070625100128/http://bouml.free.fr/[Bouml],
as proposed by _Cehteh_. Sometimes, UML design sketches are made with
https://uml.sourceforge.io/[Umbrello], while schematic drawings,
Icons and graphic elements for the GUI are maintained
with https://inkscape.org/[Inkscape]
- Test-visualisation relies heavily on
https://graphviz.org/[Graphviz] and
http://www.gnuplot.info/[Gnuplot]
Ichthyostega:: '2025-09-20'
Import old DesignProcess into rfc_pending
2010-07-23 18:24:30 +02:00
''''
clean-up: comb through the historical pages to fix markup errors Some sections of the Lumiera website document meeting minutes, discussion protocols and design proposals from the early days of the project; these pages were initially authored in the »Moin Moin Wiki« operated by Cehteh on pipapo.org at that time; this wiki backed the first publications of the »Cinelerra-3« initiative, which turned into the Lumiera project eventually. Some years later, those pages were transliterated into Asciidoc semi-automatically, resulting in a lot of broken markup and links. This is a long standing maintenance problem problem plaguing the Lumiera website, since those breakages cause a lot of warnings and flood the logs of any linkchecker run.
2025-09-08 04:04:39 +02:00
Back to link:/x/DesignProcess.html[Lumiera Design Process overview]
Reference in a new issue Copy permalink