| commit | 1c1228730764cdd3f3360f5e065d9d43cbfa10fe | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue May 20 17:07:48 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue May 20 17:07:48 2025 -0700 |
| tree | 31d8894767d8b813ce641cfe421202f9b4c046b0 | |
| parent | e044b8a448906e2a10298a1b8e44d1b82306836b [diff] |
roll: third_party/pigweed 3c95dd2..55d135f (6 commits) 55d135f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285272 bazel: Switch to stock probe-rs prebuilts e65453e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/292803 pw_work_queue: Fix initialization order issue 2726f6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293172 pw_tokenizer: Make linker script includable without copying 691e534:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293255 git: Properly gitignore external/ 5b46ebf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/291812 pw_build: Fix log line reset color check b9eb356:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/292932 pw_kernel: Add rust panic_detector utility Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 3c95dd2e71c796..55d135fa01e365 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8714307932574614865 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Icb3ae7ec31a1426423198b73217c7c6da25fa764 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/293298 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.