Skip to content

Commit 832a28e

Browse files
committed
docs: docs cleanup [skip ci]
1 parent daede2e commit 832a28e

2 files changed

Lines changed: 5 additions & 7 deletions

File tree

docs/src/dynamic_project_options.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ cmake -DOPT_<featurename>:BOOL=value
2020

2121
See `dynamic_project_options()` in action in [this template repository](https://github.com/aminya/cpp_boilerplate_project).
2222

23-
<details>
24-
<summary> 👉 Click to show the example:</summary>
23+
Here is an example of how to use `dynamic_project_options`:
24+
2525

2626
```cmake
2727
cmake_minimum_required(VERSION 3.20)
@@ -64,5 +64,3 @@ dynamic_project_options(
6464
```
6565

6666
Add your executables, etc., as described above.
67-
68-
</details>

docs/src/enable_cross_compiler.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `enable_cross_compiler`
22

3-
**NOTE**: this feature is experimental and needs more documentation/examples. See the `tests/rpi3`, `tests/rpi4`, `tests/emscripten`, `tests-rpi4-vcpkg` directories in the [repositpry](https://github.com/aminya/project_options/tree/main/tests) for full examples.
3+
**NOTE**: more documentation/examples for this feature is welcome. See the `tests/rpi3`, `tests/rpi4`, `tests/emscripten`, `tests-rpi4-vcpkg` directories in the [repositpry](https://github.com/aminya/project_options/tree/main/tests) for full examples.
44

55
The following calls `enable_cross_compiler` to enable the cross-compiler as the current toolchain.
66

@@ -57,7 +57,7 @@ For `arm-linux` or `arm64-linux`, you must set the compiler:
5757
- `-DENABLE_CROSS_COMPILING:BOOL=ON -DCMAKE_C_COMPILER=gcc-aarch64-linux-gnu-gcc -DCMAKE_CXX_COMPILER=gcc-aarch64-linux-gnu-g++ -DDEFAULT_TRIPLET=arm64-linux`
5858
- `-DENABLE_CROSS_COMPILING:BOOL=ON -DCMAKE_C_COMPILER=arm-linux-gnueabihf-gcc -DCMAKE_CXX_COMPILER=arm-linux-gnueabi-g++ -DDEFAULT_TRIPLET=arm-linux -DCROSS_ROOT=/usr/gcc-arm-linux-gnueabihf`
5959

60-
For (bare-metal) you don't need/can't(?) set `arm-linux`/`arm64-linux` (for vcpkg):
60+
For (bare-metal) you don't need/can't set `arm-linux`/`arm64-linux` for vcpkg:
6161

6262
- arm-none-eabi [arm.toolchain.cmake](https://github.com/abeimler/project_options/blob/feature/open-closed-enable-cross-compiler/src/toolchains/arm.toolchain.cmake)
6363

@@ -67,7 +67,7 @@ For (bare-metal) you don't need/can't(?) set `arm-linux`/`arm64-linux` (for vcpk
6767
- `-DENABLE_CROSS_COMPILING:BOOL=ON -DCMAKE_C_COMPILER=arm-none-eabi-gcc -DCMAKE_CXX_COMPILER=arm-none-eabi-g++ -DTARGET_ARCHITECTURE:STRING=arm -DCROSS_ROOT:STRING="/usr/arm-none-eabi-gcc"
6868
-DCROSS_TRIPLET:STRING=arm-none-eabi-gcc`
6969

70-
The option for `DEFAULT_TRIPLET` are the similarly to [vcpkg triplets](https://github.com/microsoft/vcpkg/tree/master/triplets/community/)
70+
The option for `DEFAULT_TRIPLET` are the similar to [vcpkg triplets](https://github.com/microsoft/vcpkg/tree/master/triplets/community/)
7171

7272
- x64-mingw-dynamic
7373
- x64-mingw-static

0 commit comments

Comments
 (0)