Google Git
Sign in
pigweed / pigweed / examples / 5033804edc1f111a89f417dedd4711fc609aa188
commit5033804edc1f111a89f417dedd4711fc609aa188[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed.infra.roller.pigweed-service-accounts.iam.gserviceaccount.com>Sun Mar 23 08:00:40 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sun Mar 23 08:00:40 2025 -0700
treec8e3557f1330a67d8ea167a173d1432361243cd3
parentda7227f26b25c1678d221a2271b8951c13ca2dc6 [diff]
roll: third_party/pigweed roll: luci

bb
From git_revision:0116693211c2d2f947acb9977133a516e31d1e13
To git_revision:15360378801f3e74bdadc43ea620429112a2ab6a

luci-auth
From git_revision:0116693211c2d2f947acb9977133a516e31d1e13
To git_revision:05d6f54f551fc083915e8ecf1f2d98c5b916aeb6

led
From git_revision:0116693211c2d2f947acb9977133a516e31d1e13
To git_revision:15360378801f3e74bdadc43ea620429112a2ab6a

swarming
From git_revision:0116693211c2d2f947acb9977133a516e31d1e13
To git_revision:15360378801f3e74bdadc43ea620429112a2ab6a

logdog
From git_revision:0116693211c2d2f947acb9977133a516e31d1e13
To git_revision:05d6f54f551fc083915e8ecf1f2d98c5b916aeb6

prpc
From git_revision:0116693211c2d2f947acb9977133a516e31d1e13
To git_revision:05d6f54f551fc083915e8ecf1f2d98c5b916aeb6

luci-cv
From git_revision:036d16b462ac8941d3acc3c71edae733cb9bfd5c
To git_revision:15360378801f3e74bdadc43ea620429112a2ab6a

Roll-Count: 7
GitWatcher: ignore
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278096
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Original-Revision: aa2285683111b0efb39765152fe7a0eb1169b571

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: d6d2201c41e461..aa2285683111b0
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8719597064673193553
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I2693f57d1a7628cd86e1aaa1c7bd37e1f8c8e26c
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/278272
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>
1 file changed
tree: c8e3557f1330a67d8ea167a173d1432361243cd3
  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.