commit | b84dae484ba7d0c92e2f67143ae2f9bd30eace53 | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Jan 07 12:51:29 2025 -0800 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Jan 07 12:51:29 2025 -0800 |
tree | 6e7fff8d5f8b79618e23918b6493a0a6efab8085 | |
parent | 1d3d64a4cd286608bd1fe1d5cccb621f5d1ac777 [diff] |
roll: third_party/pigweed f245559..44f63e7 (5 commits) 44f63e7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/253854 pw_fuzzer: Mark pw_cc_fuzz_tests as test-only f1611e0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257632 pw_allocator: Fix Android.bp: Add bucket/public a542e41:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/258174 pw_log_basic: Adjust field widths 57ff21b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/253853 pw_async: Add test dep and mark as test-only 902b953:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256395 [owners] Remove luluwang@google.com from pw_bluetooth/OWNERS Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: f245559459ac18..44f63e7a7f3edc Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8726369743263835873 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I52b6c19b84c6158ac09ad6e2fac6b692ac16539d Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/258459 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>
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!
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
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
All of these commands must be run from inside an activated developer environment. See Environment setup
To build the project, documentation, and tests, run the following command in an activated environment:
pw build
Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch
:
pw watch
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
Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html
.