| commit | 1b9ac1b444daa92997a04208ebf4aeea7f3876d9 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Mar 04 13:54:43 2025 -0800 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Mar 04 13:54:43 2025 -0800 |
| tree | 9a95518b060459a9d7284cc10e084b2411c95c10 | |
| parent | a0f6557ba1801536e68a7e6641473cca783b41ea [diff] |
roll: third_party/pigweed 04dc1da..77ad850 (6 commits) 77ad850:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272796 pw_presubmit: Enable buildifier formatting in Bazel d7bdeda:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272794 pw_kernel: Move scheduler locks into a sub-module b979d61:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272773 pw_toolchain: ARM Cortex-M4f configs 323d1bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272793 pw_kernel: Use mod_name.rs instead of mod_name/mod.rs e319db3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/232351 pw_metric: Use atomic operations 8d5512e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/272575 pw_presubmit: Load formatting path exclusions Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 04dc1da93d3496..77ad8508f5c888 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8721292281242738449 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I490be6759069fa794d7dba6cabce9297fd81ba95 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/272832 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.