Request for Comments-19: Provide a summary after cmake configuration

From OTBWiki
Jump to: navigation, search

[Request for Comments - 19] Provide a summary after cmake configuration

Status

  • Author: Rashad Kanavath
  • Submitted on 01.01.2000
  • Open for comments

Content

What changes will be made and why they would make a better Orfeo ToolBox?

This RFC propose to add a summary at end of cmake configuration. Currently there are version parsing and reporting path/to/.so files in the middle the cmake configure. Not all libraries report version, headers, and libs.And those who report are showing up in the middle of configure.

IMHO, this is harder to find and flying through the configure output or even CMakeCache.txt is a pain. Any otb developer could vouch for that.

Adding a summary at end of configure is very helpful for users building from source. It is relief to know that all is well. That OTB has picked up the correct libraries I had asked for.

What I having in mind is something like this:

---------------- Begin OTB Configuration Summary ----------------

ITK_DIR             /path/to/itk-dir       4.8.2
OSSIM_INCLUDE_DIR   /path/to/include         
OSSIM_LIBRARY       /path/to/lib/.so       1.8.20
GDAL_INCLUDE_DIR    /path/to/gdal/include    
GDAL_LIBRARY        /path/to/gdal/lib/.so  2.0.1dev
OPENCV_DIR          /path/to/config.Cmake  2.4.10

...

---------------- End OTB Configuration Summary ------------------

Moreover this allows developers to know user's configuration without asking for a dashboard build or CMakeCache.txt.

It can also be attached when filing a bug report on manits. (bugs.orfeo-toolbox.org).


Additional Information:
<outout of OTB configuration summary >


This may see too much verbose for some developers. But believe me we are going to save a lot of time in debugging later.

When will those changes be available (target release or date)?

OTB 5.6

Who will be developing the proposed changes?

I can do it.