#209: Fix copyright headers in documentation
----------------------+-----------------------------------------------------
Reporter: levill_r | Owner: Olena Team
Type: defect | Status: new
Priority: minor | Milestone: Olena 1.1
Component: Milena | Version: 1.0
Keywords: |
----------------------+-----------------------------------------------------
LaTeX files in milena/doc/ have the special clause:
{{{
As a special exception, you may use this file as part of a free
software library without restriction. Specifically, if other files
instantiate templates or use macros or inline functions from this
file, or you compile this file and link it with other files to
produce an executable, this file does not by itself cause the
resulting executable to be covered by the GNU General Public
License. This exception does not however invalidate any other
reasons why the executable file might be covered by the GNU General
Public License.
}}}
which is meaningless! Remove it.
Moreover, we might want to consider another license for the documentation,
like the GNU FDL or the LPPL (I'm not sure the GPL is suited for
documentation).
EDIT: The products (e.g. `tutorial.pdf`) have FDL headers! WTF?
--
Ticket URL: <https://trac.lrde.org/olena/ticket/209>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
#169: Lighten the repository
-------------------------+--------------------------------------------------
Reporter: levill_r | Owner: Olena Team
Type: enhancement | Status: new
Priority: minor | Milestone: Olena 1.0
Component: Milena | Version: 1.0
Keywords: |
-------------------------+--------------------------------------------------
Getting a fresh working copy from the repository takes time, as there are
many medium- or big-sized files (images and meshes). We should probably
remove some of them, or move them elsewhere.
Of course, we should remove most of these files from the distribution as
well.
--
Ticket URL: <https://trac.lrde.org/olena/ticket/169>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
#222: Clean up the Git repository
-----------------------------+----------------------------------------------
Reporter: levill_r | Owner: Olena Team
Type: task | Status: new
Priority: minor | Milestone:
Component: Olena | Version: 1.0
Keywords: rewrite history |
-----------------------------+----------------------------------------------
Warning, this requires a whole rewriting of the repository with `git-
filter-branch`. Notify users in advance. To be performed during
vacations?
Tasks:
* Author name: s/Nicolas Croiset/Tristan Croiset/.
* Remove copyrighted files.
* ... (list them here)
* What else?
--
Ticket URL: <https://trac.lrde.org/olena/ticket/222>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
#202: Document build procedures
----------------------+-----------------------------------------------------
Reporter: levill_r | Owner: levill_r
Type: task | Status: new
Priority: critical | Milestone:
Component: Trac | Version: 1.0
Keywords: gcc icpc |
----------------------+-----------------------------------------------------
Write a Trac page (several pages?) on these topics:
* Why `make` is the way to go.
* Why you should (normally) run `bootstrap` only once.
* Why you should (normally) run `configure` only once per build
directory.
* How to build Olena with the Intel C++ Compiler (ICC)
* By setting it a build time (not very good).
* By setting it a configuration time (better).
* By setting it in a `config.site` file (the best).
* How to automate things using `CONFIG_SITE`.
* Why compiling from Emacs (using `M-x compile`) is better than...
* ...Compiling with `make` from a terminal.
* ...Compiling with `g++` from a terminal (arg!).
This is not restricted to Olena, so we might want to move this material
elsewhere later.
--
Ticket URL: <https://trac.lrde.org/olena/ticket/202>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
#237: Provide a deterministic version of mln::labeling::colorize
----------------------+-----------------------------------------------------
Reporter: levill_r | Owner: Olena Team
Type: task | Status: new
Priority: major | Milestone:
Component: Milena | Version: 1.0
Keywords: random |
----------------------+-----------------------------------------------------
The current version of `mln::labeling::colorize` uses `rand(3)` (and
`srand(3)`), which is not guaranteed to have the same behavior on
different platforms.
While this version is perfectly acceptable, we also need a deterministic
version, working uniformly across every target host (and the
corresponding test(s), of course).
--
Ticket URL: <https://trac.lrde.org/olena/ticket/237>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
#196: Kill Doxygen warnings in Olena 1.0
--------------------+-------------------------------------------------------
Reporter: theo | Owner: Olena Team
Type: task | Status: new
Priority: major | Milestone: Olena 1.0
Component: Milena | Version: 1.0
Keywords: |
--------------------+-------------------------------------------------------
`doxygen` emits warnings for certain documented parts; adjust the
documentation or Doxygen's options to get rid of them.
--
Ticket URL: <https://trac.lrde.org/olena/ticket/196>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
#244: Make use of \snippet command with doxygen
-------------------------+--------------------------------------------------
Reporter: lazzara | Owner: Olena Team
Type: enhancement | Status: new
Priority: major | Milestone: Olena 1.2
Component: Milena | Version: 1.0
Keywords: |
-------------------------+--------------------------------------------------
Sample codes inserted in the Doxygen documentation are currently extracted
from full source codes using a shell script.
It enables the possibility to check code compilation and give full working
code to the users.
Since version 1.7.5, Doxygen added a new command, \snippet, which has this
functionality of splitting full code examples easily.
We should use it and remove all the current scripts.
--
Ticket URL: <https://trac.lrde.org/olena/ticket/244>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
#218: Check for unnecessary includes.
---------------------+------------------------------------------------------
Reporter: lazzara | Owner: Olena Team
Type: defect | Status: new
Priority: major | Milestone: Olena 1.1
Component: Milena | Version: 1.0
Keywords: |
---------------------+------------------------------------------------------
Few files may includes unnecessary files.
Write a program and include these files:
#include <mln/core/var.hh>
#include <mln/core/image/image2d.hh>
#include <mln/debug/iota.hh>
#include <mln/debug/println.hh>
#include <mln/pw/image.hh>
You will be able to use p_array and sub_image without including their
related files.
Unnecessary includes slow down compilation and is damaging.
--
Ticket URL: <https://trac.lrde.org/olena/ticket/218>
Olena <http://olena.lrde.epita.fr>
Olena, a generic and efficient C++ image processing library.
