Google Git
Sign in
pigweed / pigweed / examples / 954ffa73f3323d3ddc4867386aeae1471beffeb8
commit954ffa73f3323d3ddc4867386aeae1471beffeb8[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Sat Jun 22 00:50:24 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sat Jun 22 00:50:24 2024 +0000
treea976614a24eea37b2e43941e3cd47dd5fceeaa28
parent0903390c7918e5a27c3abee187fb8a6da738901b [diff]
roll: third_party/pigweed 13 commits

1edcc733fe2cec8 targets/rp2040: Update docs
a0b96183e45057a pw_allocator: Use specific block allocator headers
20f3739c55ea860 targets/rp2040: Add debugprobe version detection a
7bcd8c6a947594f pw_cli: Improve messaging for GitErrors
db4aa332cdf0199 pw_bluetooth_proxy: Have release_fn take buffer*
d9c9e4959765f34 pw_bluetooth_proxy: Add GetH4Span
0b1d2bfaf3402bf pw_clock_tree_mcuxpresso: Use AcquireWith for audi
ae68ff1f200c77a pw_clock_tree: Introduce ClockTree AcquireWith met
f894d1aa8d7e589 pw_target_runner: Send test binaries over gRPC
3292a27ec33acdd pw_bluetooth: Add WritePinTypeCommandCompleteEvent
3a9cb7b0cb084d5 pw_bluetooth: Add ReadPinTypeCommandCompleteEvent
3ca190b3b1553c6 pw_bluetooth: Add PinCodeRequestNegativeReplyComma
f6773e365ff933f docs: Remove mention of multiplexers

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed Rolled-Commits: 68e267dfae009b6..1edcc733fe2cec8
Roller-URL: https://ci.chromium.org/b/8744473945959033761
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ifee160e53969deb4b6a1c51ebaf9e586cc96e5b8
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/217163
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: a976614a24eea37b2e43941e3cd47dd5fceeaa28
  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. navbar.md
  29. OWNERS
  30. pigweed.json
  31. pyproject.toml
  32. README.md
  33. 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.