You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[doc] Use cmake -B args instead of cd into build dir (pytorch#19392)
Addresses the remaining item from pytorch#14759
**Files changed**
### `docs/source/using-executorch-building-from-source.md`
- Replace all 7 `cmake ..` invocations with `cmake -B cmake-out` (run
from repo root, no cd needed)
- `cmake --preset ios` (presets define binaryDir via CMakePresets.json)
- Remove redundant `mkdir cmake-out` before `cmake -B` (cmake creates it
automatically)
- Add missing `windows` preset to documented presets list (exists in
CMakePresets.json)
- Remove orphaned text fragment in "Linking Without CMake" section
(leftover from pytorch#13210)
- Fix typos: `Bulild` → `Build`, `Addition` → `Additional`, ccache ref
`above` → `below`
### `docs/source/kernel-library-selective-build.md`
- Replace `cmake ..` with `cmake -B cmake-out` in selective build
example
### `docs/source/using-executorch-runtime-integration.md`
- Fix `cmake -b` (lowercase, invalid CMake syntax) → `cmake -B`
## Test plan
- `lintrunner` passes on all 3 changed files
- Sphinx docs build succeeds with no new warnings
- Verified rendered HTML contains no remaining `cmake ..` patterns
cc @GregoryComer@mergennachin
Copy file name to clipboardExpand all lines: docs/source/using-executorch-building-from-source.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ portability details.
49
49
conda activate executorch
50
50
```
51
51
52
-
> **_NOTE:_**Addition Windows Setup
52
+
> **_NOTE:_**Additional Windows Setup
53
53
>
54
54
> ExecuTorch requires symlinks to be enabled to build the Python components. To enable symlinks, run the following command before cloning the repository. Missing symlinks will manifest as an error related to `version.py` when running `pip install .`. See [src/README.md](https://github.com/pytorch/executorch/blob/main/src/README.md) for more information.
55
55
> ```bash
@@ -129,7 +129,7 @@ When user code is not using CMake, the runtime can be built standalone and linke
>**_TIP:_** For faster rebuilds, consider installing ccache (see [Compiler Cache section](#compiler-cache-ccache) above). On first builds, ccache populates its cache. Subsequent builds with the same compiler flags can be significantly faster.
272
+
>**_TIP:_** For faster rebuilds, consider installing ccache (see [Compiler Cache section](#compiler-cache-ccache) below). On first builds, ccache populates its cache. Subsequent builds with the same compiler flags can be significantly faster.
273
273
274
274
<hr/>
275
275
@@ -298,8 +298,6 @@ To link against the runtime from outside of the CMake ecosystem, the runtime can
298
298
`-Wl,-force_load` or `-Wl,--whole-archive`. It contains load-time functions
299
299
that automatically register the kernels, but linkers will often prune those
300
300
functions by default because there are no direct calls to them.
301
-
`libportable_kernels.a`, so the program may use any of the operators it
302
-
implements.
303
301
304
302
Backends typically introduce additional targets. See backend-specific documentation for more details.
305
303
@@ -352,7 +350,9 @@ To use the ExecuTorch runtime from native Android C++ code, the runtime can be c
352
350
For direct cross-compilation, the ExecuTorch runtime can be configured to build with the NDK toolchain:
353
351
```bash
354
352
# point -DCMAKE_TOOLCHAIN_FILE to the location where ndk is installed
0 commit comments