| commit | afe1b816767ea516e86feacc6a40f33ab1df8a36 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Wed Apr 23 15:28:03 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Apr 23 15:28:03 2025 -0700 |
| tree | 2549d5fbd0d6cddde914f72c79cac0ca22c005e5 | |
| parent | 35e6be67a4a4150d6eefad6e15585bae3fdced58 [diff] |
roll: third_party/pigweed 10298a8..f294164 (7 commits) f294164:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284874 pw_hdlc: Migrate size reports to Bazel 5f93ecf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284280 pw_async2: Store and log wait reasons 768021d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284691 pw_string: Migrate size reports to Bazel d81bd23:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286092 pw_log: Define default values for tokens 8490841:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284395 pw_bluetooth_sapphire: Bump Fuchsia SDK API level to 27 478b9b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283792 pw_kernel: Add debug_assert! macro 058426c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285795 pw_containers: Migrate size reports to Bazel Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 10298a8a17a9c7..f294164713d2ab Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8716760361683037329 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I2588d7b7b8f37053fe82ebffc8ddd1889ef5dd65 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/286153 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.