Google Git
Sign in
pigweed / pigweed / examples / f15c8ebc753878af14e70f0d44aeaaf46a70c634
commitf15c8ebc753878af14e70f0d44aeaaf46a70c634[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Nov 07 20:52:14 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Nov 07 20:52:14 2024 +0000
tree861c2ed5d1a8b98ef2493ccf3e6cee45901f871c
parent278feae3db405a4e242c08fe5a1fa0ac3df75254 [diff]
roll: third_party/pigweed b2288d8..c6028ac (11 commits)

c6028ac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247613 pw_bluetooth: Remove unused MakeEmboss
d60a7ce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247612 pw_bluetooth_proxy: Migrate tests off of unchecked MakeEmboss helper
5acfafd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247592 pw_bluetooth_proxy: Use error checking MakeEmboss* helpers
b572584:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247793 pw_bluetooth: Add emboss_util rule to Android.bp
facd24c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247433 pw_build: Add CMake target for must_place linker utility
52aa0a9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247515 pw_bluetooth: Provide generic validating emboss View/Writer creators
b35502c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247455 pw_preprocessor: Remove extra semicolon in test
99dfc64:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247713 pw_bluetooth_sapphire: Remove remaining HCI packed structs
17f8803:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247532 pw_bluetooth: Add variants of MakeEmboss* util that return a Result
5f9d087:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247712 pw_bluetooth: Add uint versions of command opcode fields
5740ed0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247772 docs: Fix shortlinks

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: b2288d8bc5b909..c6028ac41e3e30
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8731896150344986113
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ib98c3fbb7442cb4571fb9e3e0970321802f95372
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/247522
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: 861c2ed5d1a8b98ef2493ccf3e6cee45901f871c
  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.