Skip to content

Commit

Permalink
style: pre-commit fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pre-commit-ci[bot] committed Jun 21, 2023
1 parent 2f3d947 commit 4cb7b49
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/migration_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,19 @@ This guidance will be updated on a best-effort basis, but if you are working at
which you can change the `build-backend` to `scikit-build-core`.
- If you specify files to include in sdists via MANIFEST.in, with
`scikit-build-core` you should now instead use the `sdist.include` and
`sdist.exclude` fields in the `tool.scikit-build` table. Note that scikit-build-core uses all non `.gitignore`'d files by default, so this is often minimal or not needed.
`sdist.exclude` fields in the `tool.scikit-build` table. Note that
scikit-build-core uses all non `.gitignore`'d files by default, so this is
often minimal or not needed.

## CMake changes

scikit-build users wishing to switch to scikit-build-core should be aware of the
following changes that must be made to their CMake files:

- The PythonExtensions CMake module distributed with scikit-build is not part of
scikit-build-core. Due to improvements in CMake's built-in support for building
Python extension modules, most of this module is no longer necessary. Change
scikit-build-core. Due to improvements in CMake's built-in support for
building Python extension modules, most of this module is no longer necessary.
Change

```cmake
find_package(PythonExtensions REQUIRED)
Expand All @@ -56,7 +59,8 @@ python_add_library(${LIBRARY} MODULE ${FILENAME})
- The UseCython CMake module distributed with scikit-build is not currently
supported. For examples on how to use Cython, see
[our getting started guide](./getting_started.md) for now.
- The `SKBUILD_CONFIGURE_OPTIONS` environment variable is now named `SKBUILD_CMAKE_ARGS` for consistency.
- The `SKBUILD_CONFIGURE_OPTIONS` environment variable is now named
`SKBUILD_CMAKE_ARGS` for consistency.
- The `SKBUILD_BUILD_OPTIONS` environment variable is not yet supported.

## Misc changes
Expand Down

0 comments on commit 4cb7b49

Please sign in to comment.