general.hpp File Reference

General documentation for the makefile "Buildsystem/ExternalSources/Makefile", responsible for external builds. More...

Go to the source code of this file.

Detailed Description

General documentation for the makefile "Buildsystem/ExternalSources/Makefile", responsible for external builds.

General overview

Basic ideas

  • The recommended version is the version installed by default; using other versions might or might not work.
  • Two basic types of installations:
    1. System-wide installation: installation in directories like /usr/local (depending on the package's own build system); requires at the end of the installation to enter the appropriate super-user password (if this was missed, then just re-run the build, which should quickly arrive at the entry-point again).
    2. Local installation: installation to directory /home/csoliver/OKplatform/ExternalSources/Installations.
    In both case, if possible, we will extract documentation to the local documentation directory /home/csoliver/OKplatform/system_directories/doc/internet_html/doc/doc.
  • The build system provides access to the results of the builds:
    1. executable programs
    2. source-code libraries
    3. link-libraries
    4. documentation
    5. other resources.
  • As part of a "holistic" or "active" library, the part of the build system responsible for building external sources is highly configurable and extensible; details are explained in Buildsystem/ExternalSources/docus/Internals.hpp.
  • The OKlibrary (and its support "staff") can offer only very restricted installation support (especially for general-purpose tools like web servers). For more information on the internal build process see Buildsystem/ExternalSources/docus/Internals.hpp.


For more permanent changes, enter into /home/csoliver/OKplatform/.oklib/override.mak the overriding definitions, for example

ocaml_bin_dir := /usr/local/bin

to use the system-wide ocaml-installation instead of the local installation. (These definitions prevent the involved variables from being (re-)defined by the configuration system.)

Since directory ExternalSources (/home/csoliver/OKplatform/ExternalSources) can become quite big, one might want to move its content to directory "OtherLocation":

  1. Enter
    ExternalSources = FullPathToOtherLocation
    into /home/csoliver/OKplatform/.oklib/override.mak; a concrete example would be
    ExternalSources = /home/user/ExternalSources
  2. Move the content of directory ExternalSources to the new place (so that the elements of ExternalSources become the elements of OtherLocation).
  3. Now the old directory ExternalSources has become empty, and is only to be used for the oklib-calls (like oklib maxima for installing Maxima).

If just a different version shall be installed, without changing settings permanently, provide the variable-settings on the command line, for example

oklib gcc gcc_recommended_version_number_okl=4.2.4

to install gcc with version 4.2.4 (similarly for any other variable setting).


User documentation on how to install supported software and basic usage (sorted alphabetically):

  1. Asciidoc (Buildsystem/ExternalSources/SpecialBuilds/docus/Asciidoc.hpp)
  2. Boost (Buildsystem/ExternalSources/SpecialBuilds/docus/Boost.hpp)
  3. CLisp (Buildsystem/ExternalSources/SpecialBuilds/docus/CLisp.hpp)
  4. Coq (Buildsystem/ExternalSources/SpecialBuilds/docus/Coq.hpp)
  5. Doxygen (Buildsystem/ExternalSources/SpecialBuilds/docus/Doxygen.hpp)
  6. ECL (Buildsystem/ExternalSources/SpecialBuilds/docus/Ecl.hpp)
  7. Gap (Buildsystem/ExternalSources/SpecialBuilds/docus/Gap.hpp)
  8. Gcc (Buildsystem/ExternalSources/SpecialBuilds/docus/Gcc.hpp)
  9. Git (Buildsystem/ExternalSources/SpecialBuilds/docus/Git.hpp)
  10. Gmp (Buildsystem/ExternalSources/SpecialBuilds/docus/Gmp.hpp)
  11. Grasp (Buildsystem/ExternalSources/SpecialBuilds/docus/Gmp.hpp)
  12. Maxima (Buildsystem/ExternalSources/SpecialBuilds/docus/Maxima.hpp)
  13. Mhash (Buildsystem/ExternalSources/SpecialBuilds/docus/Mhash.hpp)
  14. Ocaml (Buildsystem/ExternalSources/SpecialBuilds/docus/Ocaml.hpp)
  15. Picosat (Buildsystem/ExternalSources/SpecialBuilds/docus/Picosat.hpp)
  16. Postgresql (Buildsystem/ExternalSources/SpecialBuilds/docus/Postgresql.hpp)
  17. R (Buildsystem/ExternalSources/SpecialBuilds/docus/R.hpp)
  18. Sage (Buildsystem/ExternalSources/SpecialBuilds/docus/Sage.hpp)
  19. Ubcsat (Buildsystem/ExternalSources/SpecialBuilds/docus/Ubcsat.hpp)
  20. Valgrind (Buildsystem/ExternalSources/SpecialBuilds/docus/Valgrind.hpp)

The build-directories (which can always be removed after a build) are located in directory /home/csoliver/OKplatform/ExternalSources/builds.

Definition in file general.hpp.