OKlibrary  0.2.1.6
general.hpp File Reference

Build-related plans for the OKlibrary (in the strict sense) More...

Go to the source code of this file.


Detailed Description

Build-related plans for the OKlibrary (in the strict sense)

Bug:
Mixing C and C++
  • If we have files XXX.c and XXX.cpp (with the same prefix) then the build-system apparently does not work properly.
  • Either this gets corrected, or at least documented (it appears we should forbid this).
  • The build-system should also warn about this (and perhaps also about other assumptions not met).
Bug:
Incorrect build of new tests I
  • The buildsystem does not handle the dependencies for the module-test-program.
Bug:
Incorrect build of new tests II
  • While error I is as expected (at this time), the buildsystem behaves differently when called within a module or from a higher level:
    1. Target new_check works from for example from level OKsystem w.r.t. building test-object files if needed,
    2. but from within the module this doesn't work.
Todo:
Test system
  • The most immediate thing is to make the test system work correctly, which (at least?) means that the make-system gets to know the relevant dependencies, so that recompilation of tests happens whenever necessary (at this time (18.6.2006) the test object files need to be manually deleted (via "make cleantestobj") to enforce recompilation).
  • We need special test-modes for more extensive messages.
  • The output of testprograms is copied into a suitable subdirectory of system_directories/log. Perhaps also the test time-stamps should go here?
Todo:
Setting the paths to GCC and Boost link libraries
  • The setting of the Make variable "alternative_library_path" needs to be reviewed.
  • For example, the name "alternative_library_path" is no longer appropriate.
  • DONE (machine_bits_okl provides either value 32 or 64; using "uname" instead of the environment variables below) The build system should find out whether the platform is 32- or 64-bit, and select then only the needed links (environment variables HOSTTYPE and CPU).
Todo:
User control of system versions
  • There should be a simple method for the user to specify that the buildsystem uses the system-wide installations of GCC and Boost.
  • It should be possible to specify only the system-wide GCC or only the system-wide Boost, or both.
Todo:
General_options
  • The current function of "General_options" is taken over by the new variable "Debug_options".
Todo:
Dependency files
  • Since options might define macros (which might control conditional inclusion), the options when computing the dependency files should be identical to those when actually compiling the files.
  • If when creating the .d-files an error occurs (for example due to an inaccessible header file), then for some reason subsequent "make check" erroneously succeeds.
  • Using the gcc option "-MP" ?
  • We have the following problem:
    1. If one is using different paths due to symbolic links, then the dependency files contain unusable information (and must be deleted with "make cleandep").
    2. This problem seems hard to solve (one had to find out that different paths lead to the same file).
    3. So it must be documented well.
Todo:
Verbosity
  • By default the make-process outputs it's basic assumptions (what compiler to be used, what external libraries, etc.).
Todo:
Targets
  • It should be possible to build just one application, or just one implementation.
Todo:
Role of srcdir
  • An update of the following discussion is needed; compare Buildsystem/OKlibBuilding/plans/TargetSpecifications.hpp.
  • What is the role of variable srcdir ? Isn't the definition in Recursive.mak superfluous now?
  • It is used in makefile_generic (so that we can call makefiles from other places, without a change in behaviour; we should also document this), but why the definition in Recursive.mak ?
  • Can't makefile_generic define it on its own (respectively, shouldn't the definition in makefile_generic suffice) ?
  • Within recursive makefile-invocations we can use the option "--directory=DIR", while from the command line, when calling a makefile from another directory, the option "-C DIR" can be used.
  • This seems to make srcdir superfluous?
  • If so, then is it worth to keep it for convenience?
  • Those settings of srcdir which remain should (if at all) receive some inline comments (these settings are quite arcane).
Todo:
Cleaning
  • We need cleaning tools which clean up directories (not single files).
  • We need specialised cleaning for applications and link-libraries.
  • We need specialised cleaning regarding the test system:

    1. Cleaning of special or all versions of the test-timestamps.
    2. Cleaning of test-objectfiles and test-programs.
    3. Cleaning of test-dependencies.
    Todo:
    Test cleaning
    • We need specialised cleaning regarding the test system.
    • Cleaning of special or all versions of the test-timestamps.
    • Cleaning of test-objectfiles and test-programs.
    • Cleaning of test-dependencies.
    Todo:
    Error messages of gcc should be processed
    • We should support using a tool like TextFilt or STLFilt.
    Todo:
    Linking and options:
    • We need global control over dynamic/static linking. Is it the case that dynamic linking only happens with .so files?
    • Can investigate with strace tool.
    • Is it possible to specify the path exactly to a link-library at runtime?
    • Which compiler options are effective when linking? "Our" options are
      • -ansi (cc1plus)
      • -pedantic (cc1plus)
      • -Wall (cc1plus)
      • -g (cc1plus) (mentioned as "ignored" in the ld man page)
      • -03 (cc1plus)
      • -DNDEBUG (cc1plus)
      Here, the names in brackets indicate, in the case of ld (linker) and cpp (preprocessor), the executables whose man page documents the option and, in the case of cc1plus whether the help file documents the option. It seems, at first glance, that all of "our" options are only effective for the compiler.
    • CXXFLAGS is not used when linking the compilation units together --- is this how it should be, and how to set options for the linking stage?!
    • What is the meaning of the strip-binutil-tool? Shall we use it? (Always? Sometimes?) At least we should have the option.
    Todo:
    Force make
    • Calling make with the option "-B" (or "--always-make") does not work (it leads to an infinite loop) --- why is this so?
    • What can be done about it --- it would be nice to be able to force a rebuild, without having to delete some directories (this might be dangerous).
    Todo:
    Compilation information
    • We need a standardised way of how to make information about the compilation process available to a program (and also the name of the program, etc.), so that for example via --version we get as much information as possible.
    Todo:
    Nightly build
    • Full check-out of the library and full compilation and testing (i.e., create the package, un-archive it, build it with "make" and then run "make check" in it).
    • Testing should invoke valgrind (with Test_tool="valgrind --quit").
    Todo:
    Complexity system
    • "make measurements" will create an xml-file (via the boost serialisation library) with information about all operations which have been registered.
    • A little viewing-program allows to monitor these measurements (as they evolve over time).
    Todo:
    Measurements
    • Each "make test" etc. should gather summary statistics of the tests performed, like the total number of testobjects, the total time spend and so on.
    • In order to do so, a test program can be asked to serialise the statistics to a file or to standard output, and a simple evaluation program gathers these statistics.
    • Similar to the complexity measurements, for every task performed by the build system it should be possible to save the measured run time, so that the development over time for example of compile times, link times, test times can be followed, and also the influence of compilers can be considered.
    • By default, when running make only the total times are output, but in a protocol mode everything is written to a file (as for the complexity system; it should be possible for example to use the visualisation tools there to look at the developments here).
    Todo:
    New targets (needs update)
    • "create_new_module" and "create_new_submodule", which create a new subdirectory with test-program respectively new .hpp, _Tests.hpp and _Testobjects.hpp files (with additional inclusion in the testprogram).
    • "--create-links" as command for oklib, for creating symbolic links in ~/bin for all main programs:
      1. all solver and related programs

Definition in file general.hpp.