Google GitGoogle Git
Sign in
pigweed/pigweed/examples/b5aa293b64810fda85f18ed43d54d91b062e41ff
commit
b5aa293b64810fda85f18ed43d54d91b062e41ff
[log]
author
pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Sun Aug 30 16:47:56 2026 -0700
committer
CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Sun Aug 30 16:47:56 2026 -0700
tree
fd234742663c7d3f451f933fcd9e77c9aa38299c
parent
691dc7a132f9d004e210f3903f35befe5f10fecb [diff]
roll: third_party/pigweed roll: gn

From git_revision:58933a7cdbc90f70f2381f0c72e76d29be1d43a9
To git_revision:d71c4a70bd2ece461a09cbd6321970b9247fdab2

Roll-Count: 1
GitWatcher: ignore
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/465705
Original-Revision: fba14dcfb55265be0a468a305df031366f5dd26f

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: e55b6726b9727e..fba14dcfb55265
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8672000297118195617
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ie453b35998f170e19a81a819d76f605593abc487
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/465845
1 file changed
tree: fd234742663c7d3f451f933fcd9e77c9aa38299c
  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. pw
  34. pyproject.toml
  35. README.md
  36. ROLLER_OWNERS
  37. workflows.json
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/examples/+/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/examples

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.