update build instructions

Mon, 18 Dec 2023 14:25:10 +0100

author
Mike Becker <universe@uap-core.de>
date
Mon, 18 Dec 2023 14:25:10 +0100
changeset 760
52e49533e7b4
parent 759
475335643af4
child 761
61d5197d612b

update build instructions

CHANGELOG file | annotate | diff | comparison | revisions
README file | annotate | diff | comparison | revisions
docs/src/install.md file | annotate | diff | comparison | revisions
     1.1 --- a/CHANGELOG	Mon Dec 18 14:14:47 2023 +0100
     1.2 +++ b/CHANGELOG	Mon Dec 18 14:25:10 2023 +0100
     1.3 @@ -1,6 +1,7 @@
     1.4  Version 3.1 - tbd.
     1.5  ------------------------
     1.6  * fix wrong link from UCX 2 documentation to UCX 3 documentation
     1.7 +* remove CMake, except for tests at the moment, in favor of uwproj
     1.8  
     1.9  Version 3.0 - 2023-07-09
    1.10  ------------------------
     2.1 --- a/README	Mon Dec 18 14:14:47 2023 +0100
     2.2 +++ b/README	Mon Dec 18 14:25:10 2023 +0100
     2.3 @@ -19,27 +19,27 @@
     2.4  modules to minimize the library footprint. Using the build files you can create
     2.5  a static and a shared lib containing all modules, but you may also use the UCX
     2.6  sources in your project and compile specific modules by yourself to further
     2.7 -minimize the footprint.
     2.8 +minimize the footprint, e.g. when you need lists, but do not need hash maps.
     2.9  
    2.10  
    2.11  2. Build
    2.12  --------
    2.13  
    2.14 -The build processes uses CMake starting with UCX 3.0.
    2.15 -You can clone the repository or download the sources from SourceForge.
    2.16 +The build processes requires executing a simple configure script and calling
    2.17 +make. You can clone the repository or download the sources from SourceForge.
    2.18  
    2.19      wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz
    2.20      tar -xzf ucx-latest.tar.gz
    2.21      cd ucx-latest
    2.22  
    2.23 -Then create a build directory and use cmake to create the build files,
    2.24 -execute the build, and - optionally - install the files.
    2.25 +Then execute ./configure with the options you like. You can get a list of
    2.26 +all available options with ./configure --help. The recommended configuration
    2.27 +for production builds is ./configure --release.
    2.28  
    2.29 -    mkdir build
    2.30 -    cd build
    2.31 -    cmake ..
    2.32 -    cmake --build .
    2.33 -    sudo cmake --install .
    2.34 +    ./configure --release
    2.35 +    make
    2.36 +    make check                 # only available when built with tests
    2.37 +    sudo make install
    2.38  
    2.39  3. Documentation
    2.40  ----------------
     3.1 --- a/docs/src/install.md	Mon Dec 18 14:14:47 2023 +0100
     3.2 +++ b/docs/src/install.md	Mon Dec 18 14:25:10 2023 +0100
     3.3 @@ -2,21 +2,21 @@
     3.4  title: Build Instructions
     3.5  ---
     3.6  
     3.7 -The build processes uses CMake starting with UCX 3.0.
     3.8 +The build processes uses configure and make.
     3.9  First, download the source code from [Source Forge][1].
    3.10  
    3.11      wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz
    3.12      tar -xzf ucx-latest.tar.gz
    3.13      cd ucx-latest
    3.14 -    
    3.15 -Then create a build directory and use cmake to create the build files,
    3.16 -execute the build, and - optionally - install the files.
    3.17  
    3.18 -    mkdir build
    3.19 -    cd build
    3.20 -    cmake ..
    3.21 -    cmake --build .
    3.22 -    sudo cmake --install .
    3.23 +Then execute ./configure with the options you like. You can get a list of
    3.24 +all available options with ./configure --help. The recommended configuration
    3.25 +for production builds is ./configure --release.
    3.26 +
    3.27 +    ./configure --release
    3.28 +    make
    3.29 +    make check                 # only available when built with tests 
    3.30 +    sudo make install
    3.31  
    3.32  When compiling UCX 3, you can tweak the buffer sizes for small-buffer-optimization.
    3.33  You can do this, be pre-defining one or more of the following macros:

mercurial