Skip to content

Commit e079f8c

Browse files
committed
DOC: Remove the unused Sphinx batch file and correct the cache path note
Nothing references docs/make.bat; docs/Makefile remains for building the documentation. The cache-path note claimed the packaging scripts enforce the build path convention without saying that build_wheels.py does not. Its default build root matches the convention only on Windows, so a cache built by calling it directly is unusable by the reusable workflow unless --build-dir-root is set. State the paths as a table and give the command to check a finished cache.
1 parent a85082e commit e079f8c

2 files changed

Lines changed: 18 additions & 41 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -330,12 +330,25 @@ On Windows systems
330330
```
331331
332332
> [!IMPORTANT]
333-
> Build caches embed absolute paths. If you extract a tarball to a different path than it was built with, CMake will fail. Standard build paths for CI/CD are:
334-
> - manylinux (Docker): `/work/ITKPythonPackage-build`
335-
> - macOS: `/Users/svc-dashboard/D/P/ITKPythonPackage-build`
336-
> - Windows: `C:\BDR`
333+
> Build caches embed absolute paths. If you extract a tarball to a different
334+
> path than it was built with, CMake will fail. The paths CI extracts to are:
337335
>
338-
> This script ensures you are building with the correct conventions
336+
> | Platform | Path the cache must be built at |
337+
> |---|---|
338+
> | manylinux (Docker) | `/work/ITKPythonPackage-build` |
339+
> | macOS | `/Users/svc-dashboard/D/P/ITKPythonPackage-build` |
340+
> | Windows | `C:\BDR` |
341+
>
342+
> The scripts above set these for you. **`build_wheels.py` does not**: its
343+
> default build root is `<repo>/../ITKPythonPackage-build`, which matches the
344+
> convention only on Windows. A cache built by calling `build_wheels.py`
345+
> directly therefore needs `--build-dir-root` set to the path in the table, or
346+
> it will not be usable by the reusable workflow. Check a finished cache with:
347+
>
348+
> ```bash
349+
> tar -xOf <cache>.tar ITKPythonPackage-build/build/ITK-support-bld/CMakeCache.txt \
350+
> | grep CMAKE_CACHEFILE_DIR
351+
> ```
339352
340353
#### Local Caches
341354

‎docs/make.bat‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)