README updates

This commit is contained in:
Damien Elmes 2020-11-03 09:03:00 +10:00
parent 35f5358bf7
commit 27e720c6b8
3 changed files with 27 additions and 8 deletions

25
cargo/README.md Normal file
View File

@ -0,0 +1,25 @@
This folder integrates Rust crates.io fetching into Bazel.
After updating dependencies in ../rslib/Cargo.toml, change to this
folder and run python update.py to update the external Bazel repositories
to point to the updated deps.
You will need to have cargo-raze 0.6.1 or later installed, which is not
currently included in this Bazel project. You can install it by installing
rustup, then running "cargo install cargo-raze".
A couple of crates need extra work to build with Bazel, and are listed
in raze.toml. For example:
```toml
[raze.crates.ring.'0.16.15']
data_attr = "glob([\"src/**\"])"
```
After updating dependencies, if one of these crates has changed to a
new version, the version in raze.toml will need to be updated, and
update.py re-run.
The ../pylib/rsbridge folder has a dependency on pyo3, which is
special-cases in update.py. If updating the pyo3 version, raze.toml
and update.py need to be updated as well.

View File

@ -1,13 +1,9 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# #
# Fetches dependencies from ../rslib/Cargo.toml, adds pyo3 # See README.md
# for rsbridge, runs cargo update, then outputs the dependencies
# as Bazel targets.
#
EXTRA_DEPS = [ EXTRA_DEPS = [
# when updating, the version number in raze.toml will need updating too 'pyo3 = { version = "0.12.3", features = ["extension-module"] }'
'pyo3 = { version = "0.12.0", features = ["extension-module"] }'
] ]
import os import os

View File

@ -5,8 +5,6 @@ it will miss packages that are required on Windows and vice versa.
So we're stuck manually merging dependencies for now. To update deps: So we're stuck manually merging dependencies for now. To update deps:
- comment out the pyaudio line starting with https:// in requirements.txt,
as pip-tools can't handle it
- run 'bazel run update' to update requirements.txt for the current - run 'bazel run update' to update requirements.txt for the current
platform platform
- consult the git diff, and manually merge the changes, undoing the removal - consult the git diff, and manually merge the changes, undoing the removal