diff --git a/NEWS b/NEWS index eb7df407e..522280693 100644 --- a/NEWS +++ b/NEWS @@ -16,7 +16,7 @@ from `git://git.lumiera.org/LUMIERA` -In the current stage of development, the focus is primarily on the +At the current stage of development, the focus is primarily on the overall integration of fundamental functionality at all levels of the code base. @@ -36,13 +36,13 @@ is yet unfinished. As of _11/2015_ (0.pre.03):: A lot of long standing maintenance work has been done. -The Project upgraded to C++14 and Debian/Jessie as reference platform, -followed by clean-up of workarounds now obsoleted. On the GUI side, we largely -made the transition to GTK-3, which leads to a rework of our timeline widget, -which is in progress but not finished yet. This work also spurred an effort -to reorder the connection and communication between core and the UI, which -is expected to be asynchronous. Due to the limited developer resources, -work on the Engine and Player part is stalled. +The codebase has been upgraded to C++14 and Debian/Jessie as reference platform, +followed by clean-up of several workarounds now obsoleted. On the GUI side, +the transition to GTK-3 was accomplished, which however necessitates a rework +of our timeline widget, which is in progress but not finished yet. This work +also spurred an effort to reorder the connection and communication between +the core and the UI, which is expected to be asynchronous. Due to the limited +developer resources, work on the Engine and Player part is stalled. As of _10/2013_ (0.pre.02):: The data models have been elaborated and some significant parts of the session diff --git a/doc/devel/Changelog b/doc/devel/Changelog new file mode 120000 index 000000000..8c4ba8c0d --- /dev/null +++ b/doc/devel/Changelog @@ -0,0 +1 @@ +../../NEWS \ No newline at end of file diff --git a/doc/devel/Doxyfile.browse b/doc/devel/Doxyfile.browse index c88f801d2..f41ab1d6f 100644 --- a/doc/devel/Doxyfile.browse +++ b/doc/devel/Doxyfile.browse @@ -15,9 +15,11 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = Lumiera PROJECT_NUMBER = 0.pre.05~dev +PROJECT_BRIEF = "»edit your freedom«" PROJECT_LOGO = draw/rendered/LumiLogo-small.png -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO +ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES @@ -37,62 +39,87 @@ INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = YES STRIP_FROM_PATH = ../../src/ \ ../../tests/ -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = ../../src/ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO +PYTHON_DOCSTRING = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 +ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +MARKDOWN_ID_STYLE = GITHUB +TOC_INCLUDE_HEADINGS = 2 +AUTOLINK_SUPPORT = YES BUILTIN_STL_SUPPORT = YES CPP_CLI_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES +IDL_PROPERTY_SUPPORT = NO DISTRIBUTE_GROUP_DOC = NO +GROUP_NESTED_COMPOUNDS = NO SUBGROUPING = YES -TYPEDEF_HIDES_STRUCT = NO +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = YES +TYPEDEF_HIDES_STRUCT = YES +LOOKUP_CACHE_SIZE = 2 +NUM_PROC_THREADS = 0 +TIMESTAMP = DATE #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES +EXTRACT_PRIVATE = NO +EXTRACT_PACKAGE = NO EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO -HIDE_UNDOC_MEMBERS = NO +RESOLVE_UNNAMED_PARAMS = YES +HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = YES +INTERNAL_DOCS = NO CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO +SHOW_HEADERFILE = YES SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = NO -SORT_BRIEF_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = YES SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO GENERATE_TODOLIST = NO GENERATE_TESTLIST = NO -GENERATE_BUGLIST = YES +GENERATE_BUGLIST = NO GENERATE_DEPRECATEDLIST= NO -MAX_INITIALIZER_LINES = 10 +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 50 SHOW_USED_FILES = YES -SHOW_DIRECTORIES = NO SHOW_FILES = YES SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- QUIET = NO WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = YES +WARN_NO_PARAMDOC = NO +WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = doxygen-warnings-browse.txt @@ -101,34 +128,31 @@ WARN_LOGFILE = doxygen-warnings-browse.txt #--------------------------------------------------------------------------- INPUT_ENCODING = UTF-8 INPUT = ../../src/ \ + ../../tests \ + ../../admin/scons FILE_PATTERNS = *.c \ *.cc \ - *.cxx \ *.cpp \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ *.h \ *.hh \ - *.hxx \ *.hpp \ - *.h++ \ *.inc \ *.dox \ - *.C \ - *.CC \ - *.C++ \ - *.H \ - *.HH \ - *.H++ \ - *.PY \ *.py RECURSIVE = YES +EXCLUDE = EXCLUDE_SYMLINKS = YES +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -139,14 +163,15 @@ STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES +SOURCE_TOOLTIPS = YES USE_HTAGS = NO -VERBATIM_HEADERS = YES +VERBATIM_HEADERS = NO +CLANG_ASSISTED_PARSING = NO #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = lumiera:: \ lumiera_ \ lumi_ \ @@ -158,26 +183,58 @@ IGNORE_PREFIX = lumiera:: \ GENERATE_HTML = YES HTML_OUTPUT = html_browse HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE = LIGHT +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = NO +HTML_CODE_FOLDING = NO +HTML_PROJECT_COOKIE = DoxyLumiBrow +HTML_INDEX_NUM_ENTRIES = 500 GENERATE_DOCSET = NO +GENERATE_HTMLHELP = NO +GENERATE_ECLIPSEHELP = NO +TOC_EXPAND = NO DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 -FORMULA_FONTSIZE = 10 +ENUM_VALUES_PER_LINE = 4 +EXT_LINKS_IN_WINDOW = NO +HTML_FORMULA_FORMAT = svg +FORMULA_FONTSIZE = 9 +USE_MATHJAX = NO SEARCHENGINE = NO #--------------------------------------------------------------------------- -# Configuration options for other output formats +# Configuration options related to the LaTeX output #--------------------------------------------------------------------------- GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = YES +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_FILES = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = YES +LATEX_HIDE_INDICES = NO +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- GENERATE_RTF = NO GENERATE_MAN = NO GENERATE_XML = NO +GENERATE_DOCBOOK = NO GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO @@ -188,47 +245,43 @@ ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = __cplusplus DEBUG EBUG_ALPHA +EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration options related to external references #--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = +TAGFILES = +GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES EXTERNAL_PAGES = NO -PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = NO -HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES -DOT_FONTNAME = FreeSans -DOT_FONTPATH = +DOT_NUM_THREADS = 0 # use all cores CLASS_GRAPH = NO COLLABORATION_GRAPH = NO -GROUP_GRAPHS = NO +GROUP_GRAPHS = YES +HIDE_UNDOC_RELATIONS = YES UML_LOOK = YES -TEMPLATE_RELATIONS = NO +UML_LIMIT_NUM_FIELDS = 12 +TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO CALL_GRAPH = NO CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = NO DIRECTORY_GRAPH = NO -DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = +GRAPHICAL_HIERARCHY = NO +DOT_IMAGE_FORMAT = svg +INTERACTIVE_SVG = NO DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 10 -DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = NO DOT_CLEANUP = YES diff --git a/doc/devel/Doxyfile.pdf b/doc/devel/Doxyfile.pdf index 80ccc5015..430438400 100644 --- a/doc/devel/Doxyfile.pdf +++ b/doc/devel/Doxyfile.pdf @@ -1,4 +1,4 @@ -# Doxyfile 1.5.6 +# Doxyfile 1.8.13 # Variation of the Lumiera Doxygen configuration for PDF output # @@ -12,12 +12,15 @@ #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = Lumiera -PROJECT_NUMBER = 0.pre.03 -OUTPUT_DIRECTORY = +PROJECT_NUMBER = 0.pre.05~dev +PROJECT_BRIEF = "»edit your freedom«" +PROJECT_LOGO = draw/rendered/LumiLogo-small.png +OUTPUT_DIRECTORY = CREATE_SUBDIRS = YES +ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = NO +REPEAT_BRIEF = YES ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ @@ -33,28 +36,48 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES STRIP_FROM_PATH = ../../src/ \ -STRIP_FROM_INC_PATH = + ../../tests/ +STRIP_FROM_INC_PATH = ../../src/ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = NO +PYTHON_DOCSTRING = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 +ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +MARKDOWN_ID_STYLE = GITHUB +TOC_INCLUDE_HEADINGS = 2 +AUTOLINK_SUPPORT = YES BUILTIN_STL_SUPPORT = YES -TYPEDEF_HIDES_STRUCT = NO +CPP_CLI_SUPPORT = NO +IDL_PROPERTY_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +GROUP_NESTED_COMPOUNDS = NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = YES +TYPEDEF_HIDES_STRUCT = YES +LOOKUP_CACHE_SIZE = 2 +NUM_PROC_THREADS = 0 +TIMESTAMP = DATE #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- EXTRACT_ALL = NO EXTRACT_PRIVATE = NO +EXTRACT_PACKAGE = NO EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO +RESOLVE_UNNAMED_PARAMS = YES HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = YES HIDE_FRIEND_COMPOUNDS = NO @@ -62,21 +85,29 @@ HIDE_IN_BODY_DOCS = YES INTERNAL_DOCS = NO CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO +SHOW_HEADERFILE = NO SHOW_INCLUDE_FILES = NO +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = YES +SORT_MEMBERS_CTORS_1ST = YES SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO GENERATE_TODOLIST = NO -GENERATE_TESTLIST = NO +GENERATE_TESTLIST = YES GENERATE_BUGLIST = NO GENERATE_DEPRECATEDLIST= NO -MAX_INITIALIZER_LINES = 10 +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 50 SHOW_USED_FILES = NO -SHOW_DIRECTORIES = NO SHOW_FILES = YES SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages @@ -86,6 +117,7 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = NO WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO +WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = doxygen-warnings-pdf.txt @@ -93,35 +125,32 @@ WARN_LOGFILE = doxygen-warnings-pdf.txt # Configuration options related to the input files #--------------------------------------------------------------------------- INPUT_ENCODING = UTF-8 -INPUT = ../../src/ +INPUT = ../../src/ \ + ../../tests \ + ../../admin/scons FILE_PATTERNS = *.c \ *.cc \ - *.cxx \ *.cpp \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ *.h \ *.hh \ - *.hxx \ *.hpp \ - *.h++ \ *.inc \ *.dox \ - *.C \ - *.CC \ - *.C++ \ - *.H \ - *.HH \ - *.H++ \ - *.PY \ *.py RECURSIVE = YES +EXCLUDE = EXCLUDE_SYMLINKS = YES +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -132,14 +161,15 @@ STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES +SOURCE_TOOLTIPS = NO USE_HTAGS = NO VERBATIM_HEADERS = NO +CLANG_ASSISTED_PARSING = NO #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = YES -COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = lumiera:: \ lumiera_ \ lumi_ \ @@ -149,11 +179,31 @@ IGNORE_PREFIX = lumiera:: \ # Configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = NO +HTML_OUTPUT = html_browse +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE = LIGHT +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = NO +HTML_CODE_FOLDING = NO +HTML_PROJECT_COOKIE = DoxyLumiBrow +HTML_INDEX_NUM_ENTRIES = 500 +GENERATE_DOCSET = NO +GENERATE_HTMLHELP = NO +GENERATE_ECLIPSEHELP = NO +TOC_EXPAND = NO DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 -FORMULA_FONTSIZE = 10 +ENUM_VALUES_PER_LINE = 4 +EXT_LINKS_IN_WINDOW = NO +HTML_FORMULA_FORMAT = svg +FORMULA_FONTSIZE = 9 +USE_MATHJAX = NO SEARCHENGINE = NO #--------------------------------------------------------------------------- @@ -165,16 +215,24 @@ LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = YES PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES USE_PDFLATEX = YES LATEX_BATCHMODE = YES LATEX_HIDE_INDICES = NO +LATEX_BIB_STYLE = plain +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- GENERATE_RTF = NO GENERATE_MAN = NO GENERATE_XML = NO +GENERATE_DOCBOOK = NO GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO @@ -185,46 +243,43 @@ ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = __cplusplus DEBUG EBUG_ALPHA +EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration options related to external references #--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = +TAGFILES = +GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = NO -PERL_PATH = /usr/bin/perl +EXTERNAL_PAGES = NO #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = NO -HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES -DOT_FONTNAME = FreeSans -DOT_FONTPATH = +DOT_NUM_THREADS = 0 # use all cores CLASS_GRAPH = NO COLLABORATION_GRAPH = NO -GROUP_GRAPHS = NO -UML_LOOK = NO -TEMPLATE_RELATIONS = NO +GROUP_GRAPHS = YES +HIDE_UNDOC_RELATIONS = YES +UML_LOOK = YES +UML_LIMIT_NUM_FIELDS = 12 +TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO CALL_GRAPH = NO CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = NO DIRECTORY_GRAPH = NO +GRAPHICAL_HIERARCHY = NO DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = +INTERACTIVE_SVG = NO DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 10 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = YES +DOT_MULTI_TARGETS = NO GENERATE_LEGEND = NO DOT_CLEANUP = YES diff --git a/doc/devel/Status.txt b/doc/devel/Status.txt new file mode 100644 index 000000000..ea1389ec1 --- /dev/null +++ b/doc/devel/Status.txt @@ -0,0 +1,64 @@ +Development Status +================== +:Date: {localdate} + +Current Phase:: + [big green ]#Development# +// [big purple yellow-background]#Convergence# +// [big navy aqua-background ]#Release preparation# + +-> link:{ldoc}/technical/code/GitBranching.html[Git-flow] + +-> link:{ldoc}/technical/infra/Release.html[Release] + + + + +Objectives +---------- +At the current stage of development, the focus is primarily on the +overall integration of fundamental functionality at all levels of +the code base. A sequence of +link:{ldoc}/design/governance/integration.html[Integration steps] +has been defined, each driven by some pivotal functionality, +to be implemented as a »Vertical Slice«. + +Our Goal is to integrate an ongoing render process, with a render +pipeline in the engine and video output in the UI. + +- A network of Render Nodes can now be built and invoked [green]#✔# +- 🗘 The provisional buffer memory manager needs to be improved next, + to resolve a mismatch between the _Buffer Protocol_ and the + _Output Sink Protocol_, so that the target buffer of an output + sink can be used seamlessly within the Render Node network. +- Another point to be resolved next is to decide upon the design + of the _Vierwer Output Connection_, which shall be used as an + anchor point for the running playback process. +- Next we need a solution how to integrate some _Video Output_ solution + into the Lumiera UI (-> see the link:/research/videoDisplay/[recent research]), + so that it can be represented as an _Output{nbsp}Slot_. +- After that, we could look into the integration of _Job Planning_ + this _Output Slot_ with the _Scheduler_. +- Once this has been accomplished, it should be possible to fill in + the remaining parts into the _Play Process_ implementation. +- Furthermore we still need some provisional solution how to + trigger all this new functionality from the UI. + + + + +Current Release +--------------- +[red]#Lumiera is not usable yet#. + +- A »Preview Release« was + https://git.lumiera.org/?p=LUMIERA;a=tag;h=refs/tags/v0.pre.04[published at Dec 2, 2025] + +- link:/debian[DEB packages] + were built for »Trixie« and »Noble« + + +Changelog +~~~~~~~~~ + +include::Changelog[lines="26..10000"] + diff --git a/doc/devel/design_process.txt b/doc/devel/design_process.txt index df982d575..3f68cf8bd 100644 --- a/doc/devel/design_process.txt +++ b/doc/devel/design_process.txt @@ -11,8 +11,17 @@ Design Process //Menu: attach child 'rfc' -How it Works ------------- +.Formalized discussions within a group of developers +The purpose of the ``Lumiera Design Process'' is to coordinate and document +important discussions and decisions regarding the Architecture, the fundamental +technologies used, the coding framework and development methods. + +CAUTION: Since several years now, _Ichthyo_ is working alone. + + The Design process is ``dormant'' currently (2025). + + +Proceedings +----------- Design Process entries (Request for Comment) can be created by anyone. Each entry goes through several stages until it's accepted (or rejected). All our RfC entries are filed here, either in the link:rfc_final/index.html[RfC accepted] section, @@ -21,23 +30,46 @@ or as link:rfc_pending/index.html[pending RfC] or as link:rfc_dropped/index.html * Every proposal starts out as _*Idea*_, allowing other people to review and comment on it, while still working out details. * When the _Idea_ is in a proper shape and worked out in most details it becomes a _*Draft*_. This _Draft_ need to be carefully reviewed, commented, perhaps corrected and rated by the other Developers. -* We decide on some proposals to talk about that another time, these get a _*Parked*_ state. -* At some point we may decide that a _*Draft*_ becomes a _*Final*_. +* We may decide to discuss some proposals at a later date; these will be postponed for now and + transition into _*Parked*_ state. +* At some point we may decide that a _*Draft*_ is accepted and can transition to _*Final*_ state. Usually, this happens in our link:/devs-vault/meeting/index.html[monthly developers meetings]. * Sometimes proposals will become dropped for some reason, this is indicated by changing their state to _*Dropped*_, they still stay in the system for further reference. -Generally you should refrain from editing someone others proposals (except for typo and grammar fixes) -when this is not acknowledged with the original author. Rather only add comments to the pages and please -care to sign your comments in order to make it easier to find out who is the contact person for some note. +In general, you should not edit other people's proposals (except to correct typos and grammar mistakes) +unless this has been agreed upon with the original author. Instead, please only add comments at the end +of the page and sign them with your name and the date so that it is easier to follow the sequence of +arguments and to find the contact person for each note. Furthermore, when the ongoing discussion +happens to transform a proposal into something entirely different, you should not try to amend +the original proposal to reflect the changes, but rather _drop it_ and open a new one, +referring back to the original text. + + +What qualifies as RfC proposal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The RfC documents summarise important decisions where participating developers need to agree +upon some course of action, going forward. It is not the proper format to bring up ``interesting'' +ideas for general discussion, nor is it meant to document technical details and findings, or to +promote feature wishes. Prior to opening a RfC entry, an informal discussion should have taken place +to determine whether the idea has a reasonable chance of receiving support, whether there is a need +for further discussion, or whether a consensus already exists. It should also be ensured that +Someone^TM^ will take care of the implementation, or that the topic is considered important enough +to be defined as a long-term goal. + +- The proposal should revolve around a single idea, topic, method or solution +- It should be specific and describe _one_ proposed _solution approach,_ even while + the intention of the proposal might be to discuss the further direction to take, + or to achieve a decision regarding various possibilities ahead. +- The proposal should be well defined and actionable. +- It should be roughly clear what steps need to be taken to make the proposal happen. +- It _must_ be possible to underpin the benefits (``pro'') and the drawbacks (``con'') + with _valid arguments_, that can be debated by reasoning. +- It should be possible to examine and reason about at least one alternative. -What qualifies as an RfC proposal ---------------------------------- -CAUTION: to be written Handling of RfC entries in practice ------------------------------------ - +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .Adding a new Proposal: . Check if there is no similar proposal below! If yes, contact it's author and contribute to that one. . Think of a good/descriptive _Name-ID_ for the Proposal. It will be used to create a RfC sub-page, so no embedded spaces please. diff --git a/doc/technical/infra/Release.txt b/doc/technical/infra/Release.txt index 1abf38dd2..2660c60a4 100644 --- a/doc/technical/infra/Release.txt +++ b/doc/technical/infra/Release.txt @@ -3,7 +3,7 @@ Release preparation :Author: Ichthyo :Date: Nov 2025 -We have nothing to show and don't provide public releases yet -- +We have nothing to show yet and don't provide public releases -- but we ought to rehearse and practice the release process. This document contains some hints and a checklist of steps to perform for a proper release. @@ -14,6 +14,18 @@ IMPORTANT: Lumiera uses link:{ldoc}/technical/code/GitBranching.html[Git-flow] automation of these steps was not yet considered. So please be sure to adhere to the established conventions. +.Each Release has three phases +- Development +- Convergence +- Preparation + +During the »convergence phase«, all participants must prioritise code stability. +After the »release cut«, development can resume freely on branch `integration`, +while »release preparation« ensues on the _release branch_. The +published documentation branch and the website will follow suit on the +release branch. Please mark the current phase on the +link:{ldoc}/devel/Status.html[Development Status] page. + Steps to perform for a release ------------------------------ @@ -21,6 +33,7 @@ Steps to perform for a release . Pre-Release _»convergence phase«_ - care for code stability and refrain from breaking changes + - announce and mark »convergence« on the link:{ldoc}/devel/Status.html[Status] page. - verify that the _current version number_ is already set to the version number expected for the upcoming release, yet decorated with the `~dev` suffix -- if it turns out that @@ -133,5 +146,5 @@ what you set here *must* be the next version _after the release_ - clean-up and discard obsoleted old distributions and packages . Close the **Release Ticket** - + and update the link:{ldoc}/devel/Status.html[Status] page. diff --git a/wiki/thinkPad.ichthyo.mm b/wiki/thinkPad.ichthyo.mm index 7f0e3c9dc..0138b8247 100644 --- a/wiki/thinkPad.ichthyo.mm +++ b/wiki/thinkPad.ichthyo.mm @@ -162473,7 +162473,7 @@ unsigned int ThreadIdAsInt = *static_cast<unsigned int*>(static_cast<vo - + @@ -167565,11 +167565,13 @@ that situation will improve in forseeable future. - + + - - - + + + + @@ -167579,9 +167581,9 @@ that situation will improve in forseeable future. - - - + + + @@ -167599,9 +167601,9 @@ that situation will improve in forseeable future. - + - + @@ -168741,9 +168743,9 @@ that situation will improve in forseeable future. - + - + @@ -168793,8 +168795,8 @@ that situation will improve in forseeable future. - - + + @@ -169245,18 +169247,18 @@ that situation will improve in forseeable future. - - - - + + + + - - + + - + @@ -169458,8 +169460,8 @@ that situation will improve in forseeable future. - - + + @@ -169771,11 +169773,37 @@ that situation will improve in forseeable future. - - - - - + + + + + + + + +

+ ...und installiert uns eine neue Search-Applicance +

+ + + + + + + + + + + +

+ ...da hab ich jetzt etwas geschluckt — aber durch Git-flow haben wir jetzt keine festen »Standard-Namen« mehr, und können das somit immer nur temporär konfigurieren (wobei das durchaus noch für das nächste Jahr so passen dürfte) +

+ + + + + + @@ -169803,16 +169831,19 @@ that situation will improve in forseeable future. - + + - + + - + + @@ -169838,7 +169869,8 @@ that situation will improve in forseeable future. - + + @@ -169861,7 +169893,7 @@ that situation will improve in forseeable future. - + @@ -170276,7 +170308,7 @@ that situation will improve in forseeable future. - + @@ -171406,8 +171438,8 @@ that situation will improve in forseeable future. - - + + @@ -171711,8 +171743,8 @@ that situation will improve in forseeable future. - - + + @@ -172217,8 +172249,8 @@ actively maintained upstream. Please remove gdl from Debian. - - + + @@ -172587,7 +172619,7 @@ actively maintained upstream. Please remove gdl from Debian. - + @@ -172656,9 +172688,9 @@ actively maintained upstream. Please remove gdl from Debian. - - - + + + @@ -179173,8 +179205,8 @@ Since then others have made contributions, see the log for the history. - - + + @@ -179187,9 +179219,9 @@ Since then others have made contributions, see the log for the history. - - - + + + @@ -179224,7 +179256,7 @@ Since then others have made contributions, see the log for the history. - + @@ -179590,8 +179622,8 @@ Since then others have made contributions, see the log for the history. - - + + @@ -181005,7 +181037,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -181643,7 +181675,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -181738,11 +181770,11 @@ env.Command('out.bin', 'in.bin', my_action) - + - + @@ -182245,9 +182277,19 @@ env.Command('out.bin', 'in.bin', my_action) - + + + + +

+ As of _11/2025_ (0.pre.04):: +

+

+ This version is again motivated by a series of major upgrades and clean-up. Compilation now requires C++23 and Debian/Trixie is considered the reference platform. The GUI is connected to the core over an asynchronous messaging bus and the timeline display has been reshaped to accommodate flexibly nested structures of media content, instructed by the session through a series of _diff messages_. A scheduler has been implemented to drive the Render Engine, but the connection to the player and UI for output is yet unfinished. +

+ + - @@ -182268,7 +182310,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -182356,23 +182398,34 @@ env.Command('out.bin', 'in.bin', my_action) - + + + + - - + + - + + + + + + + + + - - + + @@ -182413,7 +182466,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -182435,7 +182488,8 @@ env.Command('out.bin', 'in.bin', my_action) - + + @@ -183246,7 +183300,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -183262,7 +183316,6 @@ env.Command('out.bin', 'in.bin', my_action) - @@ -183293,7 +183346,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -184272,6 +184325,7 @@ env.Command('out.bin', 'in.bin', my_action) + @@ -184456,13 +184510,14 @@ env.Command('out.bin', 'in.bin', my_action) - + - + + @@ -184476,6 +184531,7 @@ env.Command('out.bin', 'in.bin', my_action)

+ @@ -184539,6 +184595,29 @@ env.Command('out.bin', 'in.bin', my_action) + + + + + + + + + + + + + + + + + + + + + + + @@ -184571,12 +184650,16 @@ env.Command('out.bin', 'in.bin', my_action) - + + + + + - + @@ -184659,8 +184742,27 @@ env.Command('out.bin', 'in.bin', my_action) + + + + + + +

+ debugedit: debian/lumiera/usr/lib/lumiera/modules/liblumierasteam.so: Unknown DWARF DW_FORM_0x1f21 +

+

+ 636d34dc188610f6bf641fd64c67af690a256171 +

+ + - + + + + + + @@ -184681,12 +184783,12 @@ env.Command('out.bin', 'in.bin', my_action) - + - - + + @@ -185152,7 +185254,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -185380,9 +185482,9 @@ env.Command('out.bin', 'in.bin', my_action) - + - + @@ -185492,11 +185594,11 @@ env.Command('out.bin', 'in.bin', my_action) - - - - - + + + + + @@ -185519,7 +185621,7 @@ env.Command('out.bin', 'in.bin', my_action) - + @@ -185535,67 +185637,78 @@ env.Command('out.bin', 'in.bin', my_action) - + - - - + + + - + - - + + + + + + + + - - + - - + + + + + + - + - - - + + + - - - - + + + + - - - - + + + + + - - - + + + + - - - - + + + + - + @@ -185606,7 +185719,7 @@ env.Command('out.bin', 'in.bin', my_action)
  • Paketverzeichnis in den Container gemounted
    - 
    podman run -v /Werk/Gang/pack:/pack -it ichthyo/pack-debian-trixie-20250317
    + 
    podman run -v /Werk/Gang/pack:/pack -it ichthyo/pack-debian-trixie-20251117
  • im Container.... @@ -185628,8 +185741,8 @@ env.Command('out.bin', 'in.bin', my_action) - - + + @@ -185643,45 +185756,71 @@ env.Command('out.bin', 'in.bin', my_action) - - - - + + + + +

    + derzeit (12/2025) noch sehr ähnlich wie Trixie — ein Paket würde in den nächsten Monaten rasch obsolet werden +

    + +     + +     + - - + + + + + + + +

    + /etc/apt/sources.list.d/deb-lumiera.sources +

    + +     +     + + + + + + +     - + - + - - + + - - - - + + + + - - + + - - + + - - + + @@ -185689,10 +185828,49 @@ env.Command('out.bin', 'in.bin', my_action) - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -185711,40 +185889,40 @@ env.Command('out.bin', 'in.bin', my_action) - + - - - + + + - + - + - - + + - - - + + + - + - + - - + +