Google Git
Sign in
pigweed / pigweed / examples / 2f4451c3df3a67b6c445c56905acc962c019e0ea
commit2f4451c3df3a67b6c445c56905acc962c019e0ea[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Mon Oct 28 21:19:35 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Oct 28 21:19:35 2024 +0000
tree84156307d0f9eb2df664e5ce323c33252e82003d
parent031e0507b7df561dc5eab8a6327ddfba500e2b39 [diff]
roll: third_party/pigweed 8153a8a..2c0208d (8 commits)

2c0208d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/244772 pw_allocator: Properly default initialize arrays
b01f05a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/244792 pw_assert_tokenized: Rename token variable to avoid shadowing
c1c5bda:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245092 third_party/fuchsia: Copybara import
bbb4d52:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245052 pw_async2: Show DoPend() in API reference
59e05fa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/231331 pw_allocator: Add a benchmark test harness
ef5f6bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/244793 pw_assert_tokenized: Support pw_assert_HandleFailure
099eb1c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243256 pw_containers: Test more duplicates for multimap
673e56a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/244744 pw_assert: Verify PW_CHECK message arguments in the API

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 8153a8a83c45c6..2c0208dad4040e
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8732800281682796497
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ide1154e9de8066144b4f263bc5037ddcd63bca36
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/245022
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 84156307d0f9eb2df664e5ce323c33252e82003d
  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.