| commit | aeb0673aec3d0d167bfc1ae7f4da591a08dca303 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Nov 25 22:59:41 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Nov 25 22:59:41 2024 +0000 |
| tree | 99ff9b5f1a16dd61fca792b172075f27d21a1873 | |
| parent | be3d1c254a7d1b63f4f3224f52eb41d82bd053df [diff] |
roll: third_party/pigweed 22c0113..36e4b7e (8 commits) 36e4b7e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249713 pw_bluetooth_proxy: Support BR/EDR credits e4ec19f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248132 pw_bluetooth_proxy: Add RfcommChannel 9eac938:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250632 docs: Create Bazel filegroups for Doxygen inputs 5a94d1f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250672 pw_bluetooth_sapphire: DeviceClass for incoming connections 568adcf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248078 docs: Refactor SEED index autogen 126e36c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250852 pw_cli_analytics: Do not run test on device 1dece8e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250812 pw_malloc: Prevent optimizer from eliding allocations d94a24a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250532 SEED-0001: Update filenames in SEED instructions Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 22c0113f9cdb0b..36e4b7e60ee2ec Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8730257431994884017 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ib5e214530344fad2a0c61630ed573fa1007ce5d1 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/250952 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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.