| commit | 3dfea1725c412aabdfaa970ab9a7156925dc94c6 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Wed Jun 04 10:27:13 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Jun 04 10:27:13 2025 -0700 |
| tree | dbd798e413c5324a5438e027d2e226a93193c88d | |
| parent | b94d674730527fa927992d512bf948ca4042721c [diff] |
roll: third_party/pigweed 054ed2c..6b8da92 (7 commits) 6b8da92:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296152 pw_spi_mcuxpresso: Add missing override keyword 638955e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296173 pw_stream_uart_mcuxpresso: Add missing override keyword 4eeed9b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296172 pw_stream_shmem_mcuxpresso: Add missing override keyword 1689d77:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296059 pw_ide: Fix VSCode refresh compile command 2772952:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296057 pw_ide: Run interceptor after actual bazel command, use default shell c6e4c56:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295625 pw_cli: Move pw tool implementation to multitool.py 5753b9c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295132 pw_build: Add PW_MUST_PLACE_SIZE Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 054ed2cf776e89..6b8da9265c7d5d Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8712974310688851377 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I1033bd68384f95ed80c3aee4cef11a1542019c43 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/296233 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.