Google Git
Sign in
pigweed / pigweed / examples / e044b8a448906e2a10298a1b8e44d1b82306836b
commite044b8a448906e2a10298a1b8e44d1b82306836b[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Tue May 20 14:07:51 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue May 20 14:07:51 2025 -0700
tree24fad676be3e7c7753c25638d30f2b505dd31219
parent325002e4922cab84fe4ecb37974e34e4c5f8e959 [diff]
roll: third_party/pigweed b2e0f27..3c95dd2 (4 commits)

3c95dd2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/292276 pw_build_android: Introduce pw_android_common_target_support
51c5ae0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293052 pw_chre: Fix time unit conversion
28712f1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/291636 pw_tokenizer: Allow arbitrary prefixes for ELF database sections
eb9dae6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284613 pw_tokenizer: Nested Base10 and Base16 detokenization updates

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: b2e0f272ffe54c..3c95dd2e71c796
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8714319234227643937
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I9972d2030f54ee2d21ea72df7caa02e6869df34b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/293292
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 24fad676be3e7c7753c25638d30f2b505dd31219
  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.