Google Git
Sign in
pigweed / pigweed / examples / db70459d1a2a65891d9f2092dec652b71c594b6f
commitdb70459d1a2a65891d9f2092dec652b71c594b6f[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Fri Feb 28 17:06:25 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Feb 28 17:06:25 2025 -0800
treed650f6048e4c941b30a3bf80ae7caa637af1af34
parent0466aff9de92830f7ba85cc0353c9031f63e5d18 [diff]
roll: third_party/pigweed 2134bf8..cd2584d (6 commits)

cd2584d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/271752 pw_kernel: Add WaitQueue
37931c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272094 pw_bluetooth_sapphire: Fix crash in LowEnergyCentralServer
daf1fff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272092 .*: Don't depend on //pw_containers:pw_containers
3d59c24:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272112 pw_containers: Add missing dependency
3a63bba:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272074 targets/emcraft_sf2_som: rm target with no srcs
e109660:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/271688 pw_bluetooth_proxy: Add IFTTT across build files

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 2134bf8c3088bd..cd2584dffd129a
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8721642639878624881
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I2d3a6e42e464537370169a4c0a7f2cf6ba87a0a8
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/272055
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>
1 file changed
tree: d650f6048e4c941b30a3bf80ae7caa637af1af34
  1. build_overrides/
  2. docs/
  3. examples/
  4. images/
  5. infra/
  6. libraries/
  7. targets/
  8. third_party/
  9. tools/
  10. .clang-format ⇨ third_party/pigweed/.clang-format
  11. activate.sh ⇨ bootstrap.sh
  12. .bazelignore
  13. .bazelrc
  14. .bazelversion
  15. .gitattributes
  16. .gitignore
  17. .gitmodules
  18. .gn
  19. .pw_console.yaml
  20. activate.bat
  21. banner.txt
  22. bootstrap.bat
  23. bootstrap.sh
  24. BUILD.bazel
  25. BUILD.gn
  26. BUILDCONFIG.gn
  27. LICENSE
  28. MODULE.bazel
  29. navbar.md
  30. OWNERS
  31. pigweed.json
  32. pyproject.toml
  33. README.md
README.md

Pigweed Sample Project

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!

Getting started

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

Environment setup

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

Building

All of these commands must be run from inside an activated developer environment. See Environment setup

One-shot build

To build the project, documentation, and tests, run the following command in an activated environment:

pw build

Automatically build on file save

Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:

pw watch

Typical workflow

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

More info and Examples

Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html.