| commit | e75c8746b47e27b333e8a9826c55dce4225c998e | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Nov 05 17:57:38 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Nov 05 17:57:38 2024 +0000 |
| tree | bff5dab396ec762d71036108dc7884edc2241717 | |
| parent | e6a9ea219548e65f85fc943d5466c65d10339845 [diff] |
roll: third_party/pigweed 3cb8dc4..7f97693 (6 commits) 7f97693:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245312 pw_build: Fix GN rust debug opt level 322cd39:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247172 pw_bluetooth_sapphire: Embossify command status events 31d6d4f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246792 pw_bluetooth_sapphire: Embossify callbacks used with SendCommand 811a594:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246632 pw_bluetooth_sapphire: Replace instances of CommandCompleteEventParams 70d3941:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246932 pw_*: Fix typo messsage->message c638d7a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246712 pw_bluetooth: Move emboss_util from pw_bluetooth_proxy/internal Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 3cb8dc410fa5ef..7f9769315a8cf6 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8732088268501618817 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ic028d19708103ab9f1593724c9eef2ec3e4f49aa Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/247016 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: 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.