commit | c575ccbc46be797da617e6c230076dbb63f3c81f | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu May 22 17:02:02 2025 -0700 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu May 22 17:02:02 2025 -0700 |
tree | f96a3a89dfb60c0217fa50f20922f554081bbfd0 | |
parent | cc3a775b6764c9a55ad1522f218d8742ccf76dff [diff] |
roll: third_party/pigweed d043b7d..2807382 (7 commits) 2807382:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/291261 pw_console: Background command running 355e78e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293773 pw_allocator: Add AsyncPool be8c4b5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293832 pw_toolchain: Expose host_clang addr2line for downstream 258e151:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293772 pw_watch: run.py arg for controlling whether to clear the screen 9aaffef:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284857 pw_crypto: Migrate size reports to Bazel 91c2c9d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286416 pw_allocator: Migrate size report to Bazel f3c338c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293452 docs: Add note about bisecting rollers Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: d043b7d18a3450..2807382c150a0f Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8714127107510379761 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I73b3ce9917f6db5765ca82dd121dfe786fa46ab8 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/293735 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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
.