| commit | 665bf1d5ade14ecd31cd52db24485b132478af42 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Wed May 07 14:47:05 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed May 07 14:47:05 2025 -0700 |
| tree | ddcc1c7b4d13c7d56f55bd6159c3616ee1ddf450 | |
| parent | c5ac7a344d6dd460b653e3d0a436ff4e98d6edde [diff] |
roll: third_party/pigweed 8bbf389..19d9058 (4 commits) 19d9058:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288972 pw_bluetooth_sapphire: Remove unique_ptr from IsoStream rx queue 0f7f2c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288154 pw_bluetooth_sapphire: Remove unique_ptr from GenDataBlob return value f2a9ba5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288153 pw_sys_io_zephyr: Send bytes to printk if !console 86c9dd4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287976 pw_bluetooth_sapphire: Move ISO TX queue to IsoStream Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 8bbf3897485514..19d9058890ab39 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8715494595738707841 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I9ec4dd5019328f11125e77a5b5544698fd5e5220 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/289554 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.