Google Git
Sign in
pigweed / pigweed / examples / f987f028ea8f0860cc33faf52d1b4b941b2fe03e
commitf987f028ea8f0860cc33faf52d1b4b941b2fe03e[log] [tgz]
authorAustin Foxley <afoxley@pigweed.infra.roller.google.com>Tue Apr 22 12:29:47 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Apr 22 12:29:47 2025 -0700
tree582a04ab3f8c92556b543632c18ee00d0fa1f582
parentf34e48737a3fe8decc3da90a32e29a7547dd74b2 [diff]
roll: third_party/pigweed roll: clang, rust

clang:

From git_revision:553da9634dc4bae215e6c850d2de3186d09f9da5
To git_revision:03b0f55d9c6319a851a60bb084faca0e32a38f2b

rust:

From rust_revision:77a455303bf08da8eef6236b2b4422a77cd25c42
To rust_revision:afa859f8121bf2985362a2c8414dc71a825ccf2d

with matching llvm_revision:03b0f55d9c6319a851a60bb084faca0e32a38f2b

Pulled in via new combined git_revisions tag.

Original-Bug: 411404476
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284552
Tests-Not-Needed: Austin Foxley <afoxley@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Original-Revision: e38aff6439df47af515a4cb5554d4925e1621f67

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: ef778d436b0e8d..e38aff6439df47
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8716862075284345921
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I62d61210086b2fde0cbd4db94103c952dbef34a4
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/285714
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: 582a04ab3f8c92556b543632c18ee00d0fa1f582
  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.