| commit | a81bc57b8a136e5e931c3f02148f0a244798f9c4 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Feb 10 14:59:20 2025 -0800 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Feb 10 14:59:20 2025 -0800 |
| tree | 4bcc4ed835a5ed362cf9d4c16878fc81a8287d05 | |
| parent | 51f48130211124dfc27194dea3e75a31b0075cde [diff] |
roll: third_party/pigweed 72b0188..f9a09e0 (7 commits) f9a09e0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266894 pw_rpc: Formatting fix 7af59d4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/261395 pw_unit_test: Standardize Bazel interface 17a5e76:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260220 pw_bluetooth_sapphire: Move scan_id into LowEnergyDiscoverySession 5b8a5c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260219 pw_bluetooth_sapphire: Pass offloaded packet filter support down stack a76d73e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/259934 pw_ide: Enable most VSC commands for bootstrap 2368964:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266972 .*: Replace spurious gtest.h includes f27457d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266893 pw_bluetooth_sapphire: clang-tidy fix Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 72b0188233e8a3..f9a09e0de68f76 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8723281386660093969 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I92e08b374e005e66abc357b797cabbb99e653c2b Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/266954 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Commit-Queue: 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.