Lumiera
The new emerging NLE for GNU/Linux

Various details, documentation and other pieces of information regarding the infrastructure of the Lumiera project. This includes the infrastructure used for building and maintaining documentation and website.

Other tools in the ./admin folder

There are various other small tools and scripts in the admin folder which are not yet fully documented (Read the Source!).

buildVersion.py

Uses some Git magic to figure out the current version number based on the HEAD revision. In addition, it allows to bump select components of this version number, and to append a decoration suffix. We use the Git-flow branching structure, and thus this script is typically used to generate an input for the setVersion script, immediately after forking off a Release branch.

setVersion

This shell script uses sed to update the current Lumiera version number. It contains hard coded knowledge of all relevant locations in the code base where this version number is embedded and must be updated.

rfc.sh

This shell script (written by Cehteh) was used in the early days of Lumiera to create, update and manage the »RfC« entries for the Lumiera Design Process. While this formal documentation of design decisions is still considered relevant, this formalised process is suspended, as long as Ichthyo is working basically alone on the project.

treeinfo.sh

Generates a report about the projects directory structure by parsing the DIR_INFO files (which have to be maintained manually)

A DIR_INFO is just a small text file where the first line shall give a short summary about the purpose of this directory followed by arbitary text giving more details.

git_hooks

A directory containing example git hooks for signing and pushing on commit. Only use them when you know what you are doing.

vg-run.sh

convenience wrapper script to run an executable with valgrind using "typical options"; output goes to a logfile, which is fed to less afterwards.

A valgrind suppression file is generated automatically, in case there is an executable "vgsuppression" located in the same directory as the target executable.

testrunner

Script driving make and running a test, possibly under valgrind. Works only for autotools build.

vgsuppression_gen.sh

Use an existing vgsupression executable to generate a valgrind supression file.

Bitrot

Scripts which are not in use and need some makeover to be removed

testfilter.sh
rsync_docs_to_lumieraorg.sh