Google Git
Sign in
pigweed / pigweed / examples / ff74e71057f21dd86bffa7ade8fba178b4d4471a
commitff74e71057f21dd86bffa7ade8fba178b4d4471a[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Jun 06 00:51:35 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Jun 06 00:51:35 2024 +0000
tree227b7cad7914ac5b9ab3bc5c8d9eafeef3addab5
parent6b6cc078dddab0234283846053b8f7dfee0049ae [diff]
[third_party/pigweed] Roll 11 commits

21bcbe67b4552d1 pw_toolchain: Add IOKit and Security headers to ma
9cb32e34b5e88ff pw_bluetooth_proxy: Update H4HciPacket constructio
b68025de8fda296 pw_bluetooth_proxy: Add sendGattNotify stub
a4f3e67ade55ec6 pw_clock_tree_mcuxpresso: Configure ClkIn as sourc
1ffc0b72b2cf57d third_party: Add @libusb to bazel workspace
e25a26911ac036e pw_protobuf: Add module metadata
1318da19d424a2b pw_log: Add module metadata
5a42d892e61c03c pw_docgen: Add module metadata
5d2f2ae7a1ac085 pw_bloat: Add module metadata
8e598bdc21566ef third_party/freertos: Share common FreeRTOS functi
ea3f5729c910f5d pw_system: Move config variables to config.h

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed Rolled-Commits: 508e145f7f9814f..21bcbe67b4552d1
Roller-URL: https://ci.chromium.org/b/8745923454473056833
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ifc50d40b92791809656687cc9103c954e806fb21
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/214372
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: 227b7cad7914ac5b9ab3bc5c8d9eafeef3addab5
  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. activate.bat
  20. banner.txt
  21. bootstrap.bat
  22. bootstrap.sh
  23. BUILD.gn
  24. BUILDCONFIG.gn
  25. LICENSE
  26. navbar.md
  27. OWNERS
  28. pigweed.json
  29. pyproject.toml
  30. README.md
  31. WORKSPACE
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.