Google Git
Sign in
pigweed / pigweed / examples / c68517edc9edc3b189d56a3b6ab479dc8781dfd2
commitc68517edc9edc3b189d56a3b6ab479dc8781dfd2[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Fri Dec 06 01:32:33 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Dec 06 01:32:33 2024 +0000
treecf69696d44bb957f6e602626b61994fcf83327c6
parent0433ac63b7bb861c30e73d723ab2442fc42f5d69 [diff]
roll: third_party/pigweed a7c4dd8..4a28597 (5 commits)

4a28597:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240811 docs: Add Bazel style guide
bb9f65d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251914 pw_assert: Improve error messages in constant expressions
d257329:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251432 pw_protobuf_compiler: Split pw_proto_library.bzl
2bfeaec:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249754 pw_bluetooth_proxy: Add L2cap service listener API
9de12f9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252557 pw_presubmit: Remove pw_grpc from includes exception list

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: a7c4dd8b045259..4a28597bf8cc64
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8729342037615689473
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I231fe47944a1d8e7472d7d0598a23f13deb41506
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/252712
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: cf69696d44bb957f6e602626b61994fcf83327c6
  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.