Google Git
Sign in
pigweed / pigweed / examples / 519f2828a1625b19f078869f70d559bbd44ae4ef
commit519f2828a1625b19f078869f70d559bbd44ae4ef[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed.infra.roller.pigweed-service-accounts.iam.gserviceaccount.com>Sun Mar 30 07:40:58 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sun Mar 30 07:40:58 2025 -0700
tree6e347d11fabdec39716c9685ee221a7ab0206ba8
parenta5e6462fad3006ad82ba2c7aa5160a6f310953e3 [diff]
roll: third_party/pigweed roll: luci

bb
From git_revision:15360378801f3e74bdadc43ea620429112a2ab6a
To git_revision:04c096ce4162bfc4eac2ee9a4a5ac063969077a3

luci-auth
From git_revision:05d6f54f551fc083915e8ecf1f2d98c5b916aeb6
To git_revision:114c14ad0c663833c2ad2fa1fe8a7a47ce5deba9

cas
From git_revision:0116693211c2d2f947acb9977133a516e31d1e13
To git_revision:114c14ad0c663833c2ad2fa1fe8a7a47ce5deba9

led
From git_revision:15360378801f3e74bdadc43ea620429112a2ab6a
To git_revision:77f5166b21acbf6d7ac185a0b1c719730f71da44

swarming
From git_revision:15360378801f3e74bdadc43ea620429112a2ab6a
To git_revision:04c096ce4162bfc4eac2ee9a4a5ac063969077a3

logdog
From git_revision:05d6f54f551fc083915e8ecf1f2d98c5b916aeb6
To git_revision:77f5166b21acbf6d7ac185a0b1c719730f71da44

luci-cv
From git_revision:15360378801f3e74bdadc43ea620429112a2ab6a
To git_revision:04c096ce4162bfc4eac2ee9a4a5ac063969077a3

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

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 61b5a37b576792..abd0403e61717e
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8718964185023009681
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I7c97ca29425dcbbe70b3173af89e6d49c60f1876
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/280173
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: 6e347d11fabdec39716c9685ee221a7ab0206ba8
  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.