| commit | a76ed6912e15d41f3c8592106baaeb2bc263d692 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu Feb 20 17:32:07 2025 -0800 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Feb 20 17:32:07 2025 -0800 |
| tree | 71eebb8ff48825549dd401cd0d6fcf0caef23eac | |
| parent | 42aadd9e81dd82651faa05d72799e152c4eaf220 [diff] |
roll: third_party/pigweed 0c58d27..c2cc6b7 (11 commits) c2cc6b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269756 pw_presubmit: Add VS Code extension test suite 05d1f44:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269294 pw_kernel: Wire up panic handler 280634d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269214 pw_kernel: Flatten //pw_kernel/kernel aec9c4a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269232 pw_kernel: Move spinlocks into kernel crate b3864ad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269793 pw_protobuf_compiler: Tidy up nanopb_proto_library 659b94b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269138 pw_function: Guidance for using pw::Function; rework aliases 4641cef:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269754 pw_protobuf_compiler: rm deps nanopb_proto_library 85ab4d3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269792 pw_protobuf_compiler: Narrow pw_assert dep de83b5b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/261452 pw_assert: Mark :backend deprecated 2695a7e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269752 pw_bluetooth_proxy: Unregister channel before sending close event 1872404:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269332 pw_span: Restrict span_cast<T> to one-byte types Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 0c58d27272243d..c2cc6b70c7022d Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8722365957440001329 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I6fb90e369bb357360f7fa7f55b6070ca5f43dded Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/269872 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>
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.