Google Git
Sign in
pigweed / pigweed / examples / c82836705feb4e10b07dddfd73c840d0151b0128
commitc82836705feb4e10b07dddfd73c840d0151b0128[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Aug 14 19:25:16 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Aug 14 19:25:16 2025 -0700
treeaa2d5df7e96918cc8983cc1e32664f03f161f1f9
parent311b5ae06a8565d636563d1190e1fd81bceadc2f [diff]
roll: third_party/pigweed 4205cc1..10c1560 (9 commits)

10c1560:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312493 pw_kernel: Simplify ForeignRc
83bf224:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313493 pw_async2: Rename Poll<>::OutputType to Poll<>::value_type
c76ff86:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313432 pw_rpc: MaxWriteSizeBytes() function for raw call objects
46f12c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311539 pw_async2: Example for using an InlineAsyncQueue
45c247d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313453 pw_allocator: Reset UniquePtr<T[]>::size_ to 0 on Reset
0e3d7f9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313337 pw_intrusive_ptr: Add deduction guide for MakeRefCounted
262e21c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313312 pw_thread: Simplify snapshot creation in thread_analyzer_test.py
cf9ded3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313232 pw_thread: Expand description of Thread.stack_pointer field
ca04ce8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312692 docs: Add note about bazelignore

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 4205cc1313322e..10c1560a7715c2
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8706508003804871393
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Iaa64c2896762bca8df77d2f31179394eb24b03a2
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/313258
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: aa2d5df7e96918cc8983cc1e32664f03f161f1f9
  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. .clang-tidy
  16. .gitattributes
  17. .gitignore
  18. .gitmodules
  19. .gn
  20. .pw_console.yaml
  21. activate.bat
  22. banner.txt
  23. bootstrap.bat
  24. bootstrap.sh
  25. BUILD.bazel
  26. BUILD.gn
  27. BUILDCONFIG.gn
  28. LICENSE
  29. MODULE.bazel
  30. navbar.md
  31. OWNERS
  32. pigweed.json
  33. pyproject.toml
  34. 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.