commit | 2c755f46a72f1d9a358533a4de0811c6cd307248 | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu Sep 25 17:25:08 2025 -0700 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Sep 25 17:25:08 2025 -0700 |
tree | fd17a457b20cb93cc087e15fec0e0e0355ccb4db | |
parent | d43a103cf9d355307b954a635f392a272d634845 [diff] |
roll: third_party/pigweed 0dd6fdc..15af03a (7 commits) 15af03a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323817 pw_kernel: Refactor common logging backend code out of console a5c3e1b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323816 pw_kernel: Un-fork pw_status ef047b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323815 pw_kernel: Remove embedded-io deps from all but rp2350 support cf9e8b8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323814 pw_tokenizer: Refactor new() out of MessageWriter trait 812c717:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325594 pw_build_info: Remove :git_build_info_lib alias 4f146c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325693 pw_ide: Remove unused nodejs version of compile commands generator 7a79b5e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325532 pw_bluetooth_proxy: Delete ProxyHost::SendAdditionalRxCredits Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 0dd6fdc1779495..15af03a9436d3f Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8702710743259101985 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I89e77ac12a7f4f8b8ef6ccf220d8a8043f41fb07 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/325874 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
.