Chrome Release Bot (LUCI) 4762b62e7d Publish DEPS for 106.0.5249.13 | 1 year ago | |
---|---|---|
.. | ||
gnrt | 1 year ago | |
lib | 1 year ago | |
.style.yapf | 1 year ago | |
OWNERS | 1 year ago | |
README.md | 1 year ago | |
crates.py | 1 year ago | |
run_tests.sh | 1 year ago |
This directory contains tools for importing third-party Rust crates and constructing BUILD.gn files from them.
The //third_party/rust/third_party.toml
crate defines the set of crates
depended on from first-party code. Any transitive dependencies will be found
from those listed there. The file is a subset of a
standard Cargo.toml
file,
but only listing the [dependencies]
section.
To use a third-party crate «bar» version 3 from first party code, add the
following to //third_party/rust/third_party.toml
in [dependencies]
:
[dependencies]
bar = "3"
To enable a feature «spaceships» in the crate, change the entry in
//third_party/rust/third_party.toml
to include the feature:
[dependencies]
bar = { version = "3", features = [ "spaceships" ] }
BUILD.gn
files for third-party cratesTo generate BUILD.gn
files for all third-party crates, and find missing
transitive dependencies to download, use the gnrt
tool:
gnrt
to run on host machine, e.g. ninja -C out/Default gnrt
.gnrt
: e.g. out/Default/gnrt
.This will generate a BUILD.gn
file for each third-party crate and apply the
patch at //third_party/rust/gnrt_build_patch
. The BUILD.gn
file changes
will be visible in git status
and can be added with git add
.
The gnrt_build_patch
file allows fixing generated build rules as well as
adding missing BUILD.gn
files which result from bugs. The patch should only
contain BUILD.gn
file changes. Other patches
should be placed in a crate’s patches
subdirectory.
To download crate «foo», at the latest release of major version 4.x:
tools/crates/crates.py download foo 4
This will download the crate and unpack it into
//third_party/rust/foo/v4/crate
. The entire v4
directory, which includes the
crate
subdirectory as well as a generated README.chromium
file, should be
added to the repository with git add third_party/rust/foo/v4
.
Once all the crates are downloaded and crates.py gen
completes, a CL can be
uploaded to go through third-party review.
You may patch a crate in tree, but save any changes made into a diff file in
a patches/
directory for the crate. The diff file should be generated by
git-format-patch
each new patch numbered consecutively so that they can be
applied in order. For example, these files might exist if the «foo» crate was
patched with a couple of changes:
//third_party/rust/foo/v4/patches/0001-Edit-the-Cargo-toml.diff
//third_party/rust/foo/v4/patches/0002-Other-changes.diff
To update a crate «foo» to the latest version you must just re-import it at this time. To update from version «1.2» to «1.3»:
gnrt
before making any changes to //third_party/rust
.//third_party/rust/foo/v1/crate
directory, which contains the
upstream code.tools/crates/crates.py download foo 1
. This will
find the latest matching version on https://crates.io. If a more specific
version is desired, you may specify the full version.for i in $(find third_party/rust/foo/v1/patches/*); do patch -p1 < $i; done
out/<conf>/gnrt
to re-generate all third-party BUILD.gn
files.gnrt
and gnrt_unittests
. Run gnrt
and ensure no further
BUILD.gn
outputs are the same as before. Run gnrt_unittests
.The directory structure for a crate «foo» version 3.4.2 is:
//third_party/
rust/
foo/
v3/
BUILD.gn (generated by crates.py)
README.chromium
crate/
Cargo.toml
src/
...etc...
patches/
0001-Edit-the-Cargo-toml.diff
0002-Other-changes.diff