| commit | 5722da63abe5c5a759a0e1cc927cacf554f6b24e | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Mar 24 13:56:05 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Mar 24 13:56:05 2025 -0700 |
| tree | 15f4ccfffdc35cfba4308eb27b460764fda62ac5 | |
| parent | 1afb128148bdba9148b9eb2d31c9a47709db63e1 [diff] |
roll: third_party/pigweed 7bf3b52..244b3d0 (6 commits) 244b3d0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278032 pw_ide: Stricter detection of Bazel projects fd7055a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277793 pw_async2: Add debugging logs and metrics to dispatcher cdb6318:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277954 pw_ide: Allow compDB refresh of bootstrap projects df8b1de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278033 pw_ide: Fix target display name 24fc182:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278152 pw_bluetooth_sapphire: Fix common ubsan failures 089e227:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278292 pw_multibuf: Reduce stack usage in test Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 7bf3b521ae289d..244b3d0399b3d6 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8719484038147997857 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I396262e0c8357143114429238198706be71c6b3c Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/278473 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Bot-Commit: 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.