| commit | 778563f9dc5f89cb52d33ee4fe379209e17abfb4 | [log] [tgz] |
|---|---|---|
| author | Jonathon Reinhart <jrreinhart@google.com> | Mon Feb 24 17:21:49 2025 +0000 |
| committer | Jonathon Reinhart <jrreinhart@google.com> | Wed Feb 26 05:07:00 2025 +0000 |
| tree | 0c142f61ddf35561826e6d2c089d823ad9168e34 | |
| parent | 1dafd57fd332c5c8c71fb69b0c7889d0be7c66fe [diff] |
Import 'serialport' crate https://crates.io/crates/serialport/4.7.0 Request Document: go/android-rust-importing-crates For CL Reviewers: go/android3p#cl-review Notes: 1. Upstream includes the short "Source Code Form" of the MPL 2.0 license text. But ComplianceLint wants the full text. So this includes a patch to include the full license text. 2. This includes patches which update serialport to support nix 0.28. The original patches come from this GitHub PR: https://github.com/serialport/serialport-rs/pull/176 The specific commits are: * https://github.com/serialport/serialport-rs/commit/2d859aa5a861fd42a8040c1e96990cc4dd59a81c * https://github.com/serialport/serialport-rs/commit/bf7050c986e4c23714f579eec224691423fb5a32 Additional changes were made to accomodate upstream changes since the base of that PR. 3. cargo_embargo.json specifies libunescaper in the dep_blocklist because it is not actually needed, given that we aren't using udev: https://github.com/serialport/serialport-rs/issues/247 4. Tests cannot be enabled due to numerous missing dependencies (see dev-dependencies in Cargo.toml). Bug: 398963123 Test: m libserialport Test: cargo build --no-default-features Change-Id: Iec8b421d732431b0321e16d2e94426eb3cbbe995
This repository contains Rust crates imported from crates.io for use by the Android platform.
The files in this repository are managed by a tool, which you can run from this directory:
./crate_tool help
Most of the files here should not be edited manually, and pre-upload checks will catch and prevent such changes.
Do not edit Android.bp files directly. Instead, edit cargo_embargo.json and run ./crate_tool regenerate <crate name>.
Refer to the cargo_embargo documentation for more information.
Do not use external_updater. Use crate_tool as follows:
This will print every newer version of every crate:
./crate_tool updatable-crates
To check all newer versions of a crate for potential problems:
./crate_tool analyze-updates <crate name>
To update a crate to a specified version:
./crate_tool update <crate name> <version>
This does not do any repo or git operations, so if the update is successful, you will need to run repo start, git commit, repo upload, etc.
Several problems can occur when updating a crate:
patches/ directory.cargo_embargo may fail, requiring edits to cargo_embargo.jsonThe update command does not try to build the Android tree, but a recommended local test before repo upload is to build everything under external/rust:
source build/envsetup.sh lunch aosp_husky-trunk_staging-eng cd external/rust mm
Instead of running ./crate_tool update <crate name> <version>, you can edit pseudo_crate/Cargo.toml directly and run ./crate_tool regenerate <crate name>. This can be useful when pairs of crates need to be updated in lockstep. This can happen, for example, when a crate has an associated proc_macro crate. So to update foo and foo_derive together, edit the versions of both in pseudo_crate/Cargo.toml, then run:
./crate_tool regenerate foo foo_derive
If you don't have a specific crate you need to update, but want to help keep the crate repository up-to-date, the crate tool can suggest crate updates that seem likely to succeed:
./crate_tool suggest-updates
You should avoid creating patches, if possible. Every patch file is an ongoing operational burden that makes it more difficult to keep our crates up-to-date.
If a patch is absolutely necessary, you should, if possible, send a pull request to the upstream crate, so we can eliminate the Android patch in the future, when upgrading.
To create a patch for crate “foo”, edit the files directly. Then do:
git diff --relative=crates/foo -- crates/foo/<file1> crates/foo/<file2> > patches/<name>.patch`
If you stage or commit the change and the patch, you should see no new changes when you run “regenerate”.
The source code for crate_tool is here.
The basic principle of the tool is that every crate directory in crates/ must be exactly reproducible by an automatic process from a known set of inputs:
METADATA, TEST_MAPPING, and MODULE_LICENSE_* files.patches/ directory.cargo_embargo.json, which is used to generate Android.bp.Therefore, what ./crate_tool regenerate <crate name> does is:
cargo vendorMETADATA, TEST_MAPPING, etc.Android.bp by running cargo_embargo.The pre-upload check does exactly the same thing, but without the final step. Instead of replacing the directory contents, it checks that what it generated from scratch matches the actual crate directory contents.
Crate update are also built on top of regenerate. What ./crate_tool update <crate name> <version> does is:
cargo remove <crate_name>cargo add <crate_name>@=<version>./crate_tool regenerate <crate name>