Google Git
Sign in
pigweed / pigweed / examples / 374166d29a9c3689f2d1790d5b4d65b7eb31ea88
commit374166d29a9c3689f2d1790d5b4d65b7eb31ea88[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Apr 10 16:04:34 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Apr 10 16:04:34 2025 -0700
treede60729b55b0a074c93cba82f4f008d31ef280ae
parentd09e151de4618fd0fd08c2220bd9f4ee4f279df1 [diff]
roll: third_party/pigweed 1c277ee..f1819cf (11 commits)

f1819cf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282935 pw_env_setup: Roll clang-next
402011f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260419 pw_presubmit: Check that rst files are in Bazel
b60380d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282912 pw_tokenizer: Skip spaces in domains
4d02310:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282932 third_party: Add LLVM docs to Bazel build
59f60a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282914 pw_trace_tokenized: Add missing type_traits include
4387b94:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282732 pw_async2: Enable conversion warnings
68222f9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282452 pw_async2: Use IntrusiveForwardList for task wakers
b61bd3b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282814 pw_perf_test: Set log level; minor updates
72f5894:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282775 pw_rpc: Add kconfig dependency on PIGWEED_THREAD_SLEEP
69fc79a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282774 pw_sync_zephyr: Fix backend mapping for binary_semaphore
5ba1848:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282776 pw_ring_buffer: Suppring reading via a pw::Function

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 1c277ee964ab93..f1819cfd6e83af
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8717935741424634977
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I05754e4e19049c6d3e437e8111e1e339616ed3fe
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/282972
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: de60729b55b0a074c93cba82f4f008d31ef280ae
  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. .clang-tidy
  16. .gitattributes
  17. .gitignore
  18. .gitmodules
  19. .gn
  20. .pw_console.yaml
  21. activate.bat
  22. banner.txt
  23. bootstrap.bat
  24. bootstrap.sh
  25. BUILD.bazel
  26. BUILD.gn
  27. BUILDCONFIG.gn
  28. LICENSE
  29. MODULE.bazel
  30. navbar.md
  31. OWNERS
  32. pigweed.json
  33. pyproject.toml
  34. 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.