Google Git
Sign in
pigweed / pigweed / examples / 8f6461c92497bb22214e9376506e2a8c7f5958c3
commit8f6461c92497bb22214e9376506e2a8c7f5958c3[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed.infra.roller.pigweed-service-accounts.iam.gserviceaccount.com>Sun Apr 13 06:56:37 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sun Apr 13 06:56:37 2025 -0700
treea8d11db9fbc493afe17b8f0d83db784bec59412d
parente0c1a8ba3dfd7ea51b6950f305461e4970eb974b [diff]
roll: third_party/pigweed roll: luci

bb
From git_revision:049bb25feb40813970cbc8022607b05251700acc
To git_revision:016e8a97556c5e997cb8fed1b924125316edfe3d

led
From git_revision:049bb25feb40813970cbc8022607b05251700acc
To git_revision:016e8a97556c5e997cb8fed1b924125316edfe3d

swarming
From git_revision:049bb25feb40813970cbc8022607b05251700acc
To git_revision:016e8a97556c5e997cb8fed1b924125316edfe3d

luci-cv
From git_revision:049bb25feb40813970cbc8022607b05251700acc
To git_revision:016e8a97556c5e997cb8fed1b924125316edfe3d

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

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 713a0eccc14783..6fb93eff4e2b4c
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8717698389151561265
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0a69b12e969ac7999be5c6ce318051b29511dd7e
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/283592
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: a8d11db9fbc493afe17b8f0d83db784bec59412d
  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.