From 62403467f3280d2f9a71f69356ff7892124897d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Wr=C3=B3bel?= Date: Thu, 3 Feb 2022 17:34:34 +0100 Subject: [PATCH 1/3] - added `TribitsExProj_ENABLE_SECONDARY_TESTED_CODE=ON` as default - added installation description - added information regarding Fortran --- tribits/examples/TribitsExampleApp/README.md | 7 ++++--- tribits/examples/TribitsExampleProject/README.md | 16 ++++++++++++++-- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/tribits/examples/TribitsExampleApp/README.md b/tribits/examples/TribitsExampleApp/README.md index 9d9b99bb0..5d1fd6bc4 100644 --- a/tribits/examples/TribitsExampleApp/README.md +++ b/tribits/examples/TribitsExampleApp/README.md @@ -1,9 +1,10 @@ # TribitsExampleApp The example project `TribitsExampleApp` is a raw CMake project that pulls in -libraries from packages from `TribitsExampleProject`. To build against all of -the installed packages from an upstream `TribitsExampleProject`, configure, -build, and run the tests with: +libraries from packages from `TribitsExampleProject`. If subpackage C of +`TribitsExampleProject` was build, then Fortran compiler is required to build +`TribitsExampleApp`. To build against all of the installed packages from an +upstream `TribitsExampleProject`, configure, build, and run the tests with: ``` cmake \ diff --git a/tribits/examples/TribitsExampleProject/README.md b/tribits/examples/TribitsExampleProject/README.md index 217cd7343..79d39e721 100644 --- a/tribits/examples/TribitsExampleProject/README.md +++ b/tribits/examples/TribitsExampleProject/README.md @@ -3,7 +3,7 @@ The project `TribitsExampleProject` defines a TriBITS CMake project designed to provide a simple example to demonstrate how to use the TriBITS system to create a CMake build, test, and deployment system using a package-based -architecture. +architecture. To build `TribitsExampleProject` Fortran compiler is needed. To build and test the project, one must first create a build directory and configure by pointing to the TriBITS source dir `` @@ -19,16 +19,28 @@ with: -DTribitsExProj_TRIBITS_DIR= \ -DTribitsExProj_ENABLE_TESTS=ON \ -DTribitsExProj_ENABLE_ALL_PACKAGES=ON + -DTribitsExProj_ENABLE_SECONDARY_TESTED_CODE=ON \ -DCMAKE_CXX_COMPILER=g++ \ ``` -and then build and test with: +then build and test with: ``` make -j4 && ctest -j4 ``` +and then install: + +``` + make DESTDIR= install +``` + +`TribitsExampleProject` will be installed to +`/usr/local/` and this path should be then used +to point `-DCMAKE_PREFIX_PATH=/usr/local/` when +building e.g. `TribitsExampleApp` + The layout of a TriBITS project is described in: * https://tribits.org/doc/TribitsUsersGuide.html#tribits-project-structure From 004d5ce0db2a3fb05e912ed9e718b606ff8f71e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Wr=C3=B3bel?= Date: Thu, 3 Feb 2022 17:58:21 +0100 Subject: [PATCH 2/3] - added requested changes --- tribits/examples/TribitsExampleApp/README.md | 9 +++++---- tribits/examples/TribitsExampleProject/README.md | 3 ++- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/tribits/examples/TribitsExampleApp/README.md b/tribits/examples/TribitsExampleApp/README.md index 5d1fd6bc4..8711450ac 100644 --- a/tribits/examples/TribitsExampleApp/README.md +++ b/tribits/examples/TribitsExampleApp/README.md @@ -1,10 +1,11 @@ # TribitsExampleApp The example project `TribitsExampleApp` is a raw CMake project that pulls in -libraries from packages from `TribitsExampleProject`. If subpackage C of -`TribitsExampleProject` was build, then Fortran compiler is required to build -`TribitsExampleApp`. To build against all of the installed packages from an -upstream `TribitsExampleProject`, configure, build, and run the tests with: +libraries from packages from `TribitsExampleProject`. If `WithSubpackageC` +subpackage or the `MixedLang` packages are built, then a Fortran compiler +is required to build `TribitsExampleApp`. To build against all of the +installed packages from an upstream `TribitsExampleProject`, configure, +build, and run the tests with: ``` cmake \ diff --git a/tribits/examples/TribitsExampleProject/README.md b/tribits/examples/TribitsExampleProject/README.md index 79d39e721..8cca103a8 100644 --- a/tribits/examples/TribitsExampleProject/README.md +++ b/tribits/examples/TribitsExampleProject/README.md @@ -3,7 +3,8 @@ The project `TribitsExampleProject` defines a TriBITS CMake project designed to provide a simple example to demonstrate how to use the TriBITS system to create a CMake build, test, and deployment system using a package-based -architecture. To build `TribitsExampleProject` Fortran compiler is needed. +architecture. To build all of the packages from `TribitsExampleProject`, +a Fortran compiler is needed. To build and test the project, one must first create a build directory and configure by pointing to the TriBITS source dir `` From 4ced1c072a7be00eb308e1911ac1351205f02027 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Wr=C3=B3bel?= Date: Fri, 4 Feb 2022 16:41:37 +0100 Subject: [PATCH 3/3] - added requested changes --- tribits/examples/TribitsExampleProject/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/tribits/examples/TribitsExampleProject/README.md b/tribits/examples/TribitsExampleProject/README.md index 8cca103a8..ab0b5b42b 100644 --- a/tribits/examples/TribitsExampleProject/README.md +++ b/tribits/examples/TribitsExampleProject/README.md @@ -18,6 +18,7 @@ with: cmake \ -DTribitsExProj_TRIBITS_DIR= \ + -DCMAKE_INSTALL_PREFIX= -DTribitsExProj_ENABLE_TESTS=ON \ -DTribitsExProj_ENABLE_ALL_PACKAGES=ON -DTribitsExProj_ENABLE_SECONDARY_TESTED_CODE=ON \ @@ -34,12 +35,12 @@ then build and test with: and then install: ``` - make DESTDIR= install + make install ``` `TribitsExampleProject` will be installed to -`/usr/local/` and this path should be then used -to point `-DCMAKE_PREFIX_PATH=/usr/local/` when +`` and this path should be then used +to point `-DCMAKE_PREFIX_PATH=` when building e.g. `TribitsExampleApp` The layout of a TriBITS project is described in: