Google Git
Sign in
pigweed / pigweed / examples / b0b4f6460e60ea9c47c2f6b9f4d27d3da0f78744
commitb0b4f6460e60ea9c47c2f6b9f4d27d3da0f78744[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Tue Dec 17 13:53:09 2024 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Dec 17 13:53:09 2024 -0800
tree00372b4cd8cc6fc61ced49f7690f1ee58beaaf00
parent7c2c344e92fd8cd58b6ab8458c4a838b48f14516 [diff]
roll: third_party/pigweed e165669..ac4e444 (10 commits)

ac4e444:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255019 pw_multibuf: Add move tests for alloc future
81652cf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255059 pw_multibuf: Fix alloc future desired_size()
66ac324:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255018 pw_multibuf: Android.bp for multibuf allocator
2b84a1d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255016 pw_multibuf: Split async alloc out into its own target
b439dd3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255015 pw_multibuf: Move async to new MultiBufAllocatorAsync
aaaac0a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255014 pw_multibuf: Introduce supertype for alloc futures
2d063e1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/254828 pw_multibuf: Move mem notify functionality inside alloc future
0a85225:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/254827 pw_multibuf: Remove unneeded PW_NO_LOCK_SAFETY_ANALYSIS
a2459e9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255012 pw_kvs: Initialize memory for span in test
21d015f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255172 pw_bluetooth_proxy: Update TODOs for ACL fragmentation

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