Google Git
Sign in
pigweed / pigweed / examples / 51f48130211124dfc27194dea3e75a31b0075cde
commit51f48130211124dfc27194dea3e75a31b0075cde[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Mon Feb 10 12:02:33 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Feb 10 12:02:33 2025 -0800
tree71831f225b3ffc76d3dabafa44570693086bd227
parentd05e010fdfae71209bd486266437274be12309b1 [diff]
roll: third_party/pigweed ea358b7..72b0188 (6 commits)

72b0188:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/264517 pw_log: Switch to PW_CONSTEXPR_TEST to improve coverage
c4e6e1f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266133 roll: Clang
ce36b90:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266135 pw_bluetooth_sapphire: Remove SecurityManager::AssignLongTermKey
5f5ef63:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239732 pw_build_mcuxpresso: Generate Bazel/GN rules from github SDK
f8b2c52:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266032 pw_bluetooth_sapphire: Fix clang-tidy warning
7ece4db:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/266753 roll: cipd

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: ea358b710d56bf..72b0188233e8a3
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8723292688287625569
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ica16fddd70133e6949b1cd426e98f70ea647c84c
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/266953
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: 71831f225b3ffc76d3dabafa44570693086bd227
  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.