| commit | 488185d942ee40ead55cfefc48d6e8d4663a53ee | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed.infra.roller.pigweed-service-accounts.iam.gserviceaccount.com> | Sat Oct 05 16:29:01 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Sat Oct 05 16:29:01 2024 +0000 |
| tree | 857ed355da33cf53967981ac94f16e0a868ed531 | |
| parent | 09936dbddc3822fb4869fc8f2d18a7fed73d1e93 [diff] |
roll: third_party/pigweed roll: rust host From git_revision:612796c42077605fdd3c6f7dda05745d8f4dc4d8 To git_revision:f559d6188828b738ce7e7c2e4d99bf03111336d6 aarch64-unknown-linux-gnu From git_revision:612796c42077605fdd3c6f7dda05745d8f4dc4d8 To git_revision:f559d6188828b738ce7e7c2e4d99bf03111336d6 x86_64-unknown-linux-gnu From git_revision:612796c42077605fdd3c6f7dda05745d8f4dc4d8 To git_revision:f559d6188828b738ce7e7c2e4d99bf03111336d6 aarch64-apple-darwin From git_revision:612796c42077605fdd3c6f7dda05745d8f4dc4d8 To git_revision:f559d6188828b738ce7e7c2e4d99bf03111336d6 x86_64-apple-darwin From git_revision:612796c42077605fdd3c6f7dda05745d8f4dc4d8 To git_revision:f559d6188828b738ce7e7c2e4d99bf03111336d6 thumbv7m-none-eabi From git_revision:612796c42077605fdd3c6f7dda05745d8f4dc4d8 To git_revision:f559d6188828b738ce7e7c2e4d99bf03111336d6 GitWatcher: ignore Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240353 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Original-Revision: 443ee69b47aba9c8c5c158f0936462248d4f9daa Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 819e758453a9b4..443ee69b47aba9 Roller-URL: https://ci.chromium.org/b/8734902376663067009 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Iaeedbf60b85769bbb0d4130c70266b9ed6122751 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/240392 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
This repository outlines the recommended way of using Pigweed in a new or existing project. Feel free to fork this repository, or read it as a reference.
For more information see the Pigweed Getting started guide.
Check back for more complex examples and features coming soon!
Make sure you've set up Pigweed's prerequisites.
If you're on Windows, you can automate the initial setup by downloading the first-time setup script from cmd.exe:
curl https://pigweed.googlesource.com/pigweed/sample_project/+/main/tools/setup_windows_prerequisites.bat?format=TEXT > setup_pigweed_prerequisites.b64 && certutil -decode -f setup_pigweed_prerequisites.b64 setup_pigweed_prerequisites.bat && del setup_pigweed_prerequisites.b64
Then you can run the script with the following command in cmd.exe:
setup_pigweed_prerequisites.bat
Note: You may see a few UAC prompts as the script installs Git, Python, and enables developer mode.
Once that is done, you can clone this project with the following command:
git clone https://pigweed.googlesource.com/pigweed/sample_project
Pigweed uses a local development environment for most of its tools. This means tools are not installed to your machine, and are instead stored in a directory inside your project (Note: git ignores this directory). The tools are temporarily added to the PATH of the current shell session.
To make sure the latest tooling has been fetched and set up, run the bootstrap command for your operating system:
Windows
bootstrap.bat
Linux & Mac
source ./bootstrap.sh
After tooling updates, you might need to run bootstrap again to ensure the latest tools.
After the initial bootstrap, you can use use the activate scripts to configure the current shell for development without doing a full update.
Windows
activate.bat
Linux & Mac
source ./activate.sh
All of these commands must be run from inside an activated developer environment. See Environment setup
To build the project, documentation, and tests, run the following command in an activated environment:
pw build
Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:
pw watch
When you pull latest repository changes, run bootstrap:
source ./bootstrap.sh
If you're just launching a new shell session, you can activate instead:
source ./activate.sh
and rebuild with:
pw build
Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html.