Google Git
Sign in
pigweed / pigweed / examples / 69c7712201ffd24c3393fcac187057e5edf1d600
commit69c7712201ffd24c3393fcac187057e5edf1d600[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Fri Feb 07 15:09:29 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Feb 07 15:09:29 2025 -0800
treea240c13908a7f863c501d454aa12b26a6be32897
parente7c321acc2fc87f503d98ec68d3d76c66346cd8b [diff]
roll: third_party/pigweed 3c04c1c..e7c7ee6 (10 commits)

e7c7ee6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266152 pw_kernel: Add experimental prototype
cbc2c8a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265992 pw_toolchain: Document pw::ConstexprTag
0093c1c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266132 docs: Update changelog
101907b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265616 docs: Update Bazel docgen guide
e450027:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/263872 pw_presubmit: Add rp2350 to presubmit
0ccbac3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265876 pw_toolchain: Move pw::ConstexprTag to pw_toolchain
82c223e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265873 pw_hex_dump: Enable layering check
42dcfa3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266113 pw_bluetooth_proxy: Add missing `parameter_total_size` to test helper
ec7307e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266092 bazel: Add stub kernel bazel_presubmit program
4103b07:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266112 docs: Update bazel_integration.rst

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 3c04c1c1c81f5a..e7c7ee636711ea
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8723552620784768193
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0fbdc025df82e2c0fbf545e23692d94a03d8c0c6
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/266054
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: a240c13908a7f863c501d454aa12b26a6be32897
  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.