Recommend `-G Ninja` in all in-tree documentation. (#15328)
We strongly recommend using https://ninja-build.org/. Other generators
typically work, but ninja is fast by default and is portable to all of
our supported platforms.
Found these with a few regex searches (mainly `cmake -B` and
`^\s*cmake.*-B`)
diff --git a/samples/custom_module/async/README.md b/samples/custom_module/async/README.md
index a947c96..718d53b 100644
--- a/samples/custom_module/async/README.md
+++ b/samples/custom_module/async/README.md
@@ -28,7 +28,7 @@
2. Build the `iree_samples_custom_module_async_run` CMake target :
```
- cmake -B ../iree-build/ -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
+ cmake -B ../iree-build/ -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
-DCMAKE_C_FLAGS=-DIREE_VM_EXECUTION_TRACING_FORCE_ENABLE=1
cmake --build ../iree-build/ --target iree_samples_custom_module_async_run
```
diff --git a/samples/custom_module/basic/README.md b/samples/custom_module/basic/README.md
index bd1ad5d..60522d5 100644
--- a/samples/custom_module/basic/README.md
+++ b/samples/custom_module/basic/README.md
@@ -50,7 +50,7 @@
3. Build the `iree_samples_custom_module_run` CMake target :
```
- cmake -B ../iree-build/ -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
+ cmake -B ../iree-build/ -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
-DCMAKE_C_FLAGS=-DIREE_VM_EXECUTION_TRACING_FORCE_ENABLE=1
cmake --build ../iree-build/ --target iree_samples_custom_module_basic_run
```
diff --git a/samples/custom_module/dynamic/README.md b/samples/custom_module/dynamic/README.md
index fb60474..8f7a807 100644
--- a/samples/custom_module/dynamic/README.md
+++ b/samples/custom_module/dynamic/README.md
@@ -45,7 +45,7 @@
3. Build the `iree_samples_custom_module_dynamic_module` CMake target :
```
- cmake -B ../iree-build/ -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
+ cmake -B ../iree-build/ -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
-DCMAKE_C_FLAGS=-DIREE_VM_EXECUTION_TRACING_FORCE_ENABLE=1
cmake --build ../iree-build/ \
--target iree-run-module \
diff --git a/samples/custom_module/static/README.md b/samples/custom_module/static/README.md
index 7595de3..0f7c26f 100644
--- a/samples/custom_module/static/README.md
+++ b/samples/custom_module/static/README.md
@@ -50,7 +50,7 @@
3. Configure the IREE tools to include the custom module:
```
- cmake -B ../iree-build/ -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
+ cmake -B ../iree-build/ -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
-DCMAKE_C_FLAGS=-DIREE_VM_EXECUTION_TRACING_FORCE_ENABLE=1 \
-DIREE_EXTERNAL_TOOLING_MODULES=static_sample \
-DIREE_EXTERNAL_TOOLING_MODULE_STATIC_SAMPLE_SOURCE_DIR=${CMAKE_CURRENT_SOURCE_DIR}/samples/custom_module/static \
diff --git a/samples/custom_module/sync/README.md b/samples/custom_module/sync/README.md
index 2478b64..fcb6755 100644
--- a/samples/custom_module/sync/README.md
+++ b/samples/custom_module/sync/README.md
@@ -28,7 +28,7 @@
2. Build the `iree_samples_custom_module_sync_run` CMake target :
```
- cmake -B ../iree-build/ -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
+ cmake -B ../iree-build/ -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo . \
-DCMAKE_C_FLAGS=-DIREE_VM_EXECUTION_TRACING_FORCE_ENABLE=1
cmake --build ../iree-build/ --target iree_samples_custom_module_sync_run
```
diff --git a/samples/dynamic_shapes/README.md b/samples/dynamic_shapes/README.md
index a82d939..b2c0ceb 100644
--- a/samples/dynamic_shapes/README.md
+++ b/samples/dynamic_shapes/README.md
@@ -93,7 +93,7 @@
for general instructions on building using CMake)
```
- cmake -B ../iree-build/ -DCMAKE_BUILD_TYPE=RelWithDebInfo .
+ cmake -B ../iree-build/ -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo .
cmake --build ../iree-build/ --target iree-compile
```
diff --git a/samples/static_library/README.md b/samples/static_library/README.md
index 3b84bf2..4a38dfd 100644
--- a/samples/static_library/README.md
+++ b/samples/static_library/README.md
@@ -37,7 +37,7 @@
for general instructions on building using CMake):
```shell
- cmake -B ../iree-build/ \
+ cmake -B ../iree-build/ -G Ninja \
-DCMAKE_BUILD_TYPE=RelWithDebInfo .
-DIREE_BUILD_SAMPLES=ON \
-DIREE_TARGET_BACKEND_DEFAULTS=OFF \
diff --git a/samples/variables_and_state/README.md b/samples/variables_and_state/README.md
index 79f9e51..e4ebd7e 100644
--- a/samples/variables_and_state/README.md
+++ b/samples/variables_and_state/README.md
@@ -66,7 +66,7 @@
for general instructions on building using CMake)
```
- cmake -B ../iree-build/ -DCMAKE_BUILD_TYPE=RelWithDebInfo .
+ cmake -B ../iree-build/ -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo .
cmake --build ../iree-build/ --target iree_samples_variables_and_state
```
