From ce225746d6eb0b00d49ce4e67a40ff56cadd2008 Mon Sep 17 00:00:00 2001
From: Lars Bilke <lars.bilke@ufz.de>
Date: Tue, 1 Mar 2022 14:27:23 +0100
Subject: [PATCH] [web,ci] Removed `-S .`-paramter on CMake preset commands.
Is not required when already in the source directory.
---
scripts/ci/extends/template-build-linux.yml | 2 +-
scripts/ci/extends/template-build-win.yml | 2 +-
.../docs/devguide/advanced/offline-build.md | 4 ++--
.../getting-started/build-configuration.md | 14 +++++++-------
web/content/docs/devguide/testing/test-data.md | 2 +-
5 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/scripts/ci/extends/template-build-linux.yml b/scripts/ci/extends/template-build-linux.yml
index d8f7eb41104..56e8ee326a8 100644
--- a/scripts/ci/extends/template-build-linux.yml
+++ b/scripts/ci/extends/template-build-linux.yml
@@ -15,7 +15,7 @@
- ([ "${CONAN_USER_HOME}" == "${CI_PROJECT_DIR}/.conan" ]) && conan remove --system-reqs '*'
- ([[ $BUILD_CTEST_LARGE_ON_MASTER && "${CI_COMMIT_BRANCH}" == "master" && "${CMAKE_ARGS}" == *"USE_PYTHON=ON"* ]]) && export BUILD_CTEST_LARGE=true
script:
- - cmake -S . --preset=$CMAKE_PRESET -Wno-dev $CMAKE_ARGS
+ - cmake --preset=$CMAKE_PRESET -Wno-dev $CMAKE_ARGS
- |
if [[ -z "$TARGETS" ]]; then
diff --git a/scripts/ci/extends/template-build-win.yml b/scripts/ci/extends/template-build-win.yml
index 0eeac0e89b1..3aac32f9b7a 100644
--- a/scripts/ci/extends/template-build-win.yml
+++ b/scripts/ci/extends/template-build-win.yml
@@ -15,7 +15,7 @@
- mkdir build
# Create symlink https://stackoverflow.com/a/34905638/80480
- cmd /c mklink /D build\$env:CMAKE_PRESET $env:CI_PROJECT_DIR\$build_directory_full
- - $cmake_cmd = "cmake -S . --preset=$env:CMAKE_PRESET -Wno-dev $env:CMAKE_ARGS"
+ - $cmake_cmd = "cmake --preset=$env:CMAKE_PRESET -Wno-dev $env:CMAKE_ARGS"
- $cmake_cmd
- Invoke-Expression $cmake_cmd
- cmake --build --preset=$env:CMAKE_PRESET --target package | Tee-Object -FilePath $log_file
diff --git a/web/content/docs/devguide/advanced/offline-build.md b/web/content/docs/devguide/advanced/offline-build.md
index 096880eadd1..11860d95f7e 100644
--- a/web/content/docs/devguide/advanced/offline-build.md
+++ b/web/content/docs/devguide/advanced/offline-build.md
@@ -29,7 +29,7 @@ On the [cpm package page](https://gitlab.opengeosys.org/ogs/ogs/-/packages/1) do
Unarchive the cpm cache into a directory. Configure OGS as usual but point to the extracted cpm cache:
```bash
-cmake -S . --preset release -DCPM_SOURCE_DIR=./path/to/cpm
+cmake --preset release -DCPM_SOURCE_DIR=./path/to/cpm
```
There will be some CMake warnings from CPM regarding missing git repositories in the cache. You can ignore them.
@@ -48,5 +48,5 @@ On the [external dependencies package page](https://gitlab.opengeosys.org/ogs/og
Unarchive the external dependencies cache into a directory. Configure OGS as usual but point to the extracted external dependencies cache:
```bash
-cmake -S . --preset release -DOGS_EXTERNAL_DEPENDENCIES_CACHE=./path/to/ext
+cmake --preset release -DOGS_EXTERNAL_DEPENDENCIES_CACHE=./path/to/ext
```
diff --git a/web/content/docs/devguide/getting-started/build-configuration.md b/web/content/docs/devguide/getting-started/build-configuration.md
index f9386d60418..b931580523d 100644
--- a/web/content/docs/devguide/getting-started/build-configuration.md
+++ b/web/content/docs/devguide/getting-started/build-configuration.md
@@ -41,11 +41,11 @@ We provide CMake configuration presets defined in [CMakePresets.json](https://gi
### Configure with a preset
-In the source directory run `cmake`:
+In the source directory run `cmake` with a preset:
```bash
-# Usage: cmake -S [path-to-source] --preset=[preset-name]
-cmake -S . --preset release
+# Usage: cmake --preset=[preset-name]
+cmake --preset release
```
This will create a build-directory outside the source tree (`../build/release`) with the default CMake options and the Release configuration.
@@ -93,7 +93,7 @@ You can create a `CMakeUserPresets.json` file in the root source directory with
To use the Ninja build tool you need to configure in the Visual Studio command line. In the Start menu under *Visual Studio {{< dataFile "versions.minimum_version.msvc.year" >}}* you find a application link to *x64 Native Tools Command Prompt for VS {{< dataFile "versions.minimum_version.msvc.year" >}}*. This starts a command line setup for Visual Studio 64-bit. Now you can use a Ninja preset:
```bash
-cmake -S . --preset=release
+cmake --preset=release
```
#### <i class="far fa-exclamation-triangle"></i> Multi-configuration with Conan and Visual Studio
@@ -101,8 +101,8 @@ cmake -S . --preset=release
With Conan one build directory corresponds to one configuration. If you want to have e.g. a release and a debug build you need to create two build directories. This is nothing new to Linux / GCC user but differs to Visual Studios default behavior having just one build-folder / project with different configurations. A typical Visual Studio setup with both Release and Debug configs would be initialized as follows:
```bash
-cmake -S . --preset=msvc-release
-cmake -S . --preset=msvc-debug
+cmake --preset=msvc-release
+cmake --preset=msvc-debug
```
Please also note that in Visual Studio you have to choose the correct configuration (i.e. when opening the solution-file in the release-folder you have to switch the Visual Studio configuration to **Release**)!
@@ -151,7 +151,7 @@ CMake comes with a graphical tool called **cmake-gui**. You can find it in the *
A more convenient way of running cmake on the command line is to use the `ccmake` tool. This is a shell tool but with some graphical user interface. To use it just run `ccmake` instead of `cmake`:
```bash
-ccmake -S . --preset=release
+ccmake --preset=release
```
First press <kbd>C</kbd> to **Configure**. You are now presented the available configuration options. You can navigate in the list with the cursor keys and toggle / alter options with <kbd>Enter</kbd>. You may also press <kbd>T</kbd> to toggle (previously hidden) advanced options. Press <kbd>C</kbd> again until the **Generate**-option becomes visible. Press <kbd>G</kbd> to generate the project files and exit `ccmake`.
diff --git a/web/content/docs/devguide/testing/test-data.md b/web/content/docs/devguide/testing/test-data.md
index dcdf1231842..43811b4e637 100644
--- a/web/content/docs/devguide/testing/test-data.md
+++ b/web/content/docs/devguide/testing/test-data.md
@@ -44,7 +44,7 @@ ctest --preset release -j 6 --label-regex Utils # run 6 tests in parallel which
**To sum up:** from a clean source directory you can fully configure, build and test ogs with these 3 commands:
```bash
-cmake -S . --preset release
+cmake --preset release
cmake --build --preset release
ctest --preset release
```
--
GitLab