Google Git
Sign in
pigweed / pigweed / examples / bd15cd7257978bc62d7a40e2d7692cd073ed0ae8
commitbd15cd7257978bc62d7a40e2d7692cd073ed0ae8[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Feb 06 15:12:33 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Feb 06 15:12:33 2025 -0800
treeef3d8c063bbc8984b1f75cdd04b8ef12cea3eb4e
parentac75116db9ac03c0544af9c4bb52487229be2f16 [diff]
roll: third_party/pigweed 72685e5..15611b6 (8 commits)

15611b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265774 *: Add missing `inline` specifiers
16ddae8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/263692 pw_containers: Add explicit constexpr constructor for Vector
2971654:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/264635 pw_allocator: Satisfy layering check
f1c7e6d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/264516 pw_unit_test: Add #includes and namespace to PW_CONSTEXPR_TEST example
5ca7ab7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265772 pw_build_info: Fix building from CoG
7c348ce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265732 pw_string: Fix clang-tidy finding
33f736d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/265394 pw_containers: Return iterator after last erased element in pw::Vector
c6f84aa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/263812 pw_bluetooth_sapphire: Document how to use the Zxdb Debugger

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 72685e57f73680..15611b68e9527f
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8723643030549996257
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I58aa490aaf86aa1a72efe93d8b2aa5d5f3048492
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/265794
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: ef3d8c063bbc8984b1f75cdd04b8ef12cea3eb4e
  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.