Skip to content

Commit

Permalink
docs: Add "unstable_features"
Browse files Browse the repository at this point in the history
and remove the respective section from the README instead.
  • Loading branch information
har7an committed Feb 13, 2024
1 parent 05645c9 commit ae9cf8c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,14 +260,6 @@ passthrough = [

For more detailed documentation on which environment variables are automatically passed to the build environment, see [Environment Variable Passthrough](https://github.com/cross-rs/cross/wiki/Configuration#environment-variable-passthrough) on our wiki.

### Unstable Features

Certain unstable features can enable additional functionality useful to
cross-compiling. Note that these are unstable, and may be removed at any
time (particularly if the feature is stabilized or removed), and will
only be used on a nightly channel.

- `CROSS_UNSTABLE_ENABLE_DOCTESTS=true`: also run doctests.

### Mounting volumes into the build environment

Expand Down
9 changes: 9 additions & 0 deletions docs/unstable_features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Certain unstable features can enable additional functionality useful to
cross-compiling. Note that these are unstable, and may be removed at any time
(particularly if the feature is stabilized or removed), and will only be used
on a nightly channel.

Here is the list of currently available unstable features:

- `CROSS_UNSTABLE_ENABLE_DOCTESTS`: enable or disable running doctests
(example: `true`)

0 comments on commit ae9cf8c

Please sign in to comment.