Commit graph

145 commits

Author SHA1 Message Date
60b6267eac DOC: after release 0.pre.03 -- checklist with steps for release preparation 2015-11-20 06:12:59 +01:00
d6d8ddd536 DOC: remove hotfix patch from backporting/Mint howto
this patch is no longer required; we lowered the
version dependencies in the package proper
2015-11-15 07:10:45 +01:00
e1f7165208 DOC: instructions for building/backporting on Mint 17.2 (Rafaela)
this is a bit trickty, since we need to install gcc-4.9 from a PPA.
Mint only provides the libstdc++ 4.8, which is known to break when
compiling in C++14 mode
2015-11-05 03:27:55 +01:00
8a707f3a41 post-release: tighten library dependencies
NOTE: we have the policy to always support current Debian/stable
amd at least one Ubuntu LTS release, unless hard dependency problems prevent that.
Currently, Ubuntu/Trusty is already a bit dated, but the only problematic dependency
could be libboost (1.54 in Trusty, 1.55 in Jessie).
GCC-4.8 can be replaced by GCC-4.9 in Trusty without problems

It is always a bit tricky to find out the precise lower boundary,
so we try to upgrade these requirements as our platform progresses.
For now we have used the level available on Ubuntu/Trusty to set
the lower constraints for most libraries
2015-11-03 03:39:00 +01:00
12cefe914e release prep: clean-up obsolete information 2015-11-02 21:14:24 +01:00
b1b89c168e release prep: clean-up obsolete information 2015-11-02 19:38:43 +01:00
9c9b31f0f8 DOC: External Tree Description as a design concept
This page gives the rationale for the way our diff framework is built.
This reasoning might *reduce* the relevance of any decisions
regarding the implementation data structure and thus lead to
far reaching consequences for the whole architecture.
2015-11-02 04:50:53 +01:00
0e615e531f DOC: extension of the diff framework to represent structural changes 2015-11-02 03:51:04 +01:00
0b41ddefd0 DOC: how to use gcc-4.9 on Ubuntu Trusty (14.04 LTS) 2015-11-02 01:34:31 +01:00
80e78492d2 Reference platform for Lumeira is now Debian/Jessie 2015-08-16 02:49:53 +02:00
c2d5896a3b Project: switch to C++14
This means we have rather tight compiler requirements now.
Beyond that, we expect no serious impact; the most notable
C++14 feature we're likely to use soon is type inference
on lambda arguments.
2015-08-16 01:43:04 +02:00
dece405801 LANDING: transition to GTK-3
This switches the Lumiera UI from GTK-2 to GTK-3
Unfortunately, this move breaks two crucial features, which have been
disabled for now: the display of video and our custom timeline widget.

Since both of these require some reworking, which in fact has already
started, we prefer to do the library and framework switch right away.
2015-05-30 17:11:41 +02:00
4c4a430728 DOC: summarise suitable mechanisms for dependency decoupling
This too was a long-standing issue. While these practices
basically can be considered "common knowledge", experience
showed those topics are frequently unknown even to practised
programmers.

So now we have a single page dealing with all those issues of
code bloat, dependency poliferation, binary dependency resolution
and issues of transitive and circular library dependencies
2015-05-28 03:05:49 +02:00
182f6ac8e5 DOC: upgrade dependencies to reflect the transition to GTK-3
the corresponding requirements are already reflected in the
SCons build, see Platform.py

NOTE: the current debian package is still based on the preview
Release 0.2.pre from last year. It will be upgraded probably after
the transition to Jessie as reference system
2015-05-28 00:24:25 +02:00
e447fa9a0e DOC: workaround when --as-needed linking breaks auto-registration (closes #948)
This piece of documentation describes an insideous special case, which
some time ago prevented us from switching to --as-needed linking.
We treat this as a special case (and it is way easier to do so
now, after the reorganisation of our test suite).

deliberately, I've left #948 open to nudge me about writing this doc
2015-05-27 21:12:55 +02:00
6c7628fdfe DOC: the RPATH and RUNPATH tags and the $ORIGIN token
This is very arkane, hard to find knowledge about some intricacies
of the dynamic library resolution. Very relevant for Lumiera,
since we use a resolution scheme relative to the location
of the executable. Documenting this stuff was a long-standing issue
2015-05-27 18:52:15 +02:00
f17b1c8428 DOC: locating of dependencies and resources at application start-up
a long standing TODO to document the actual start-up sequence, which
is implemented this way since a long time now. There was an unwritten
section in the "Linking and Application Structure", which seems the
apropriate place for this kind of intricate techincal details.

Last week, Benny Lyons was here on visit in munich and he was pondering
the idea of an experimental secondary build system, as a way to learn
more about the source structure of Lumiera. This reminded me to fill
some missing parts of the documentation. Possibly this is also the
right moment to land the GTK-3 transition?
2015-05-27 04:01:09 +02:00
4e597cf0ce DOC: re-read and improve wording 2015-01-02 09:39:24 +01:00
beb57cde22 DOC: decision to use a simplistic implementation to start with
This means to discontinue any research into emitting an optimal
diff verb sequence for now and just to document the possible path
I see to reach at such a optimal solution later, when it turns out
to be really necessary performance wise.

Personal note: I arrived at this conclusion while whatching the
New Year fireworks 2014/2015 at the banks of the Isar river in
the centre of the city.
Too sad that 2014 didn't bring us World War III
2015-01-01 04:11:20 +01:00
73f310eb23 DOC: reread and slightly reworded 2014-12-23 02:18:28 +01:00
d1a5b0bf70 DOC: didactical improvement 2014-12-22 23:55:54 +01:00
d670f3bada DOC: fix in table 2014-12-22 19:19:30 +01:00
fe9105f321 DOC: reasoning behind the construction of our list diff algorithm
this is a theoretical description of our method, and gives
the reaoning why it is correct, plus the assesment of
size and complexity order.
2014-12-22 05:20:49 +01:00
42f69b6cb5 DOC: assumptions and definitions for diff handling
...plus a started draft of the list diff algorithm
2014-12-21 07:48:04 +01:00
3dc5c83b33 DOC: small howto improvements 2014-12-01 01:31:19 +01:00
41ad41d1f1 clean-up: sourcefile layout and spell checking
Uniform sequence at start of source files
- copyright claim
- license
- file comment
- header guard
- lumiera includes
- library / system includes

Lumiera uses Brittish spelling. Add an according note to the styleguide.
2014-10-23 23:04:35 +02:00
7c9ab5fba2 reorganise test suite compartments
this change is prerequisite to allow linking against different scopes (#938)
2014-10-17 20:02:25 +02:00
3fb838a041 DOC: some notorious problems to check when breakpoints in Eclipse dont work 2014-10-14 02:42:16 +02:00
5b6ebeaa5f stylesheet: finish definition of a base style
- text entry colours
- hover / mouse over
- disabled entries
- ensure consistent menu styling
2014-10-09 03:44:02 +02:00
5f4871a46a DOC: how to learn styling and extract binary theme bundles 2014-10-08 05:14:07 +02:00
a603199207 DOC: start documentation of Lumiera GUI theming 2014-10-07 04:59:45 +02:00
073efdf6a4 DOC: extend the description of dependency pitfals and intricasies
Still not complete, but a complete outline now
2014-10-02 04:08:26 +02:00
b5de8523b1 DOC: start a page to describe linking dependency intricasies 2014-10-01 04:07:18 +02:00
aaaad8d70f DOC: some clean-up in the page describing the build system 2014-10-01 01:19:56 +02:00
0eda9ff69c DOC: guidelines regarding c++11 move semantics 2014-09-25 21:23:19 +02:00
177eb0fab3 DOC: notes regarding the current level of C++11 support 2014-09-13 04:55:57 +02:00
79b19b270f DOC: add a page with notes on the IDE setup 2014-08-16 00:03:55 +02:00
50faee12b3 DOC: update the Boost-page to reflect what's part of the language now
several C++11 features used to be Boost features in the past
2014-08-16 00:03:32 +02:00
faf62cf8af DOC: start a page with C++11 notes (here: about type conversion)
note down some results found out during the C++11 transition.
There is now a clear distinction between automatic type conversion
and the ability to construct a new instance
2014-08-13 03:08:00 +02:00
027386d76c DOC: Tighten the build requirements to C++11 and Boost-1.55 2014-04-29 09:51:00 +02:00
e7769b4bbf Build: make dependency on X-Lib explicit
The XV-Viewer widget in our GUI uses four direct calls
to the X-Lib. This was discovered by strict dependency checking,
as mandated by new Debian policy
2013-11-03 00:07:07 +01:00
2cfc7030c0 release prep: clean-up obsolete information 2013-10-29 06:11:18 +01:00
d15ec47f9e DOC: some further round-up and polishsing 2013-10-28 06:14:42 +01:00
2c4ed4ca91 DOC: update and polish the building tutorial 2013-10-28 00:19:03 +01:00
9652c7ec5e Debian/Repo: reorganise the Git repository URLs
all debian package repositories are now located below
git://lumiera.org/debian/...
2013-10-27 10:18:38 +01:00
2b437b49ad DOC: switch on TOC and footnotes on some pages 2013-10-07 04:41:19 +02:00
48431d822d Build: adjust versions and naming to comply with Debian/Jessie
Note: this drops some backwards compatibility. We're targeting now
roughly the range between Ubuntu-Precise (LTS) and Debian/testing,
with Debian/stable as the reference system.

The naming scheme for Boost-Libraries was adjusted with Boost-1.42
for Unix-Platforms. Now the '-mt' suffix isn't included any more, but
the libraries available through the usual packaging mechanisms can be
assumed to be thread safe.

See also http://issues.lumiera.org/ticket/759
2013-10-07 01:52:57 +02:00
a5022a6c79 DOC: test support tools - adapt to the changes recently done on master 2013-01-08 02:51:43 +01:00
cec25b074e Integrate from TiddlyWiki: Pages about tests and test helpers 2013-01-03 11:22:41 +01:00
Christian Thaeter
7d964825d3 internal RFC reorganization
* rfcs are now all stored in the rfc folder (formerly hold the final rfcs)
* a new rfc_final folder is created
* the state folders (rfc_final|pending|parked|dropped) now contain
  symlinks back to the rfc pool
2012-08-30 20:50:08 +02:00
f7a9414084 Documentation of the SCons buildsystem 2012-01-11 06:56:37 +01:00
0e08f269f5 remove the superfluous TiddlyWikis
..after integrating all still relevant asciidoced content
into the main website.
2012-01-11 06:55:54 +01:00
2bc5d3b367 document further library facilities, some clean-up 2012-01-08 00:14:05 +01:00
d2c5297a9d document our custom iterator concept 2012-01-08 00:13:23 +01:00
484149e73e add a section for library technical documentation 2012-01-08 00:12:54 +01:00
adc120fecb document the new formatting helper, based on boost::format 2011-12-31 07:54:16 +01:00
2d1e098d2c crosslink to the TypedID concept in the TiddlyWiki 2011-12-28 03:55:15 +01:00
1d7d63e27c document a hack for guessing implementation sizes 2011-12-28 03:40:39 +01:00
2791339841 some practical hints and informations regarding usage of the Boost Libraries
Add a page to the 'coding howto' section, listing those boost libraries we're
using heavily, with a short characterisation for each. Plus some informations
about potential problems
2011-12-26 05:54:56 +01:00
d6f5ed3282 technical overview: document some library and support facilities 2011-12-10 03:15:40 +01:00
336d4cb33f technical overview: player and engine interface 2011-12-10 01:52:51 +01:00
11f0438942 spelling and some small additions 2011-12-10 01:41:21 +01:00
00813a0169 long standing issue: a style guide page 2011-11-27 06:15:35 +01:00
bb2ca862ac reference distribution for building is now Debian/Squeeze 2011-10-21 01:53:05 +02:00
f0b443abde add a page for documenting shady details and other smells 2011-10-14 22:46:04 +02:00
e1854ec490 Add Debian packaging informations to the documentation 2011-10-14 03:36:36 +02:00
5269904e06 New documentation section for code base layout and conventions 2011-10-14 03:35:39 +02:00
924944f607 write down some know-how regarding standard hash functions 2011-10-14 01:10:16 +02:00
64cf3c9d34 update GDB-pretty-printer HOWTO
Eclipse now supports structured display of STL containers
2011-08-25 03:03:43 +02:00
51b3f0defa start a page to collect technical notes about Scheduler and Jobs (Backend)
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-22 00:50:23 +02:00
cd57901d52 sync documentation with current master 2011-05-15 04:07:30 +02:00
Christian Thaeter
dc8dd98308 FIX: asciidoc formating glitches, rfc.sh documentation 2011-04-14 19:14:03 +02:00
1e1c3706dc update some DIR_INFO entries 2011-04-05 00:44:30 +02:00
ef4545bc55 augment the debian packaging and repository documentation 2011-03-28 07:01:12 +02:00
5bb9250ddb page to document the debian packaging and depot management 2011-03-13 08:35:04 +01:00
Christian Thaeter
7e17839c91 Add some short description about the tools and scripts in the ./admin dir 2011-03-10 01:31:44 +01:00
Christian Thaeter
b4f7613f81 Asciidoced documentation for rfc.sh and put it into the docs 2011-03-10 00:58:11 +01:00
3099fb7b11 reordering overview pages in User and Technical documentation 2011-03-04 02:48:31 +01:00
7c2b0f82a2 Proc-Layer technical documentation: refer to the TiddlyWiki 2011-02-28 01:25:27 +01:00
07804bed2c integrate the RfC entries into the new website structure 2011-02-27 21:42:12 +01:00
4c44b5844f document added directive (srcdirs)
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-02-21 09:09:55 +01:00
02eec48c3b Documentation of the new menu generating script for the website
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-02-21 08:24:58 +01:00
5487c244d6 small change to try the new menugen-auto-script
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-02-21 02:34:16 +01:00
e766adc1f2 more notes...
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-02-21 01:45:35 +01:00
ffb5b212f8 Add notes regarding the menugen script
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-02-21 01:45:35 +01:00
Stefan Kangas
d21747e512 doc: Several minor fixes and structural improvements. 2011-02-20 20:40:13 +01:00
Stefan Kangas
10766fe92a Replace several "Warning: Website under construction" with appropriate stubs. 2011-02-20 20:24:30 +01:00
21118d4831 Add a note about Python pretty printers in GDB 2011-01-07 18:03:26 +01:00
a53515bf30 the_inner_core is considered rather a piece of technical documentation 2010-11-18 22:49:25 +01:00
42c26c9086 fix a link 2010-11-18 22:32:49 +01:00
Simon Larcher
885c2c9ee7 Minor changes on doc index and technical doc index
Intended to make pages more user friendly. Formatted pages structures and added text
2010-11-18 22:21:48 +01:00
9085de3e15 adjust overview pages and link in further content 2010-11-17 04:41:28 +01:00
414f8a066d move in and adjust some of the asciidoced design documents 2010-11-17 04:41:28 +01:00
3bd7c610fc Move in the existing documentation outline from the Website-repository 2010-11-17 04:41:28 +01:00
58ce4b51ad added the documentation overview pages from the new website-draft 2010-11-14 03:38:43 +01:00