Google Git
Sign in
pigweed / pigweed / examples / 3ab413cb9ff0180c5d6233047be621a537ce8263
commit3ab413cb9ff0180c5d6233047be621a537ce8263[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed.infra.roller.pigweed-service-accounts.iam.gserviceaccount.com>Sun Feb 09 09:04:33 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sun Feb 09 09:04:33 2025 -0800
tree47b7db9ae2a7196295f60835484eb6383bd253ba
parent86176eecfd53e38c8b40e9dc1d514c6a354322a7 [diff]
roll: third_party/pigweed roll: luci

bb
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

luci-auth
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

gerrit
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

gitiles
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

cas
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

led
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

swarming
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

logdog
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:1d97564d4009b07ef64817627d209c7991f854d0

prpc
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

luci-cv
From git_revision:292f95eae340d5db6c574abb76257f6e140cf501
To git_revision:2a3544e8fd8784cc2fe07b5bb1072cbc99569ef9

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

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 0c62aa44067177..a9df994246205c
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8723394387454759617
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Iefd4ccfa80687ef24e279a992c5c64637542ab62
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/266532
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: 47b7db9ae2a7196295f60835484eb6383bd253ba
  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.