| commit | e76bbf8679c9be26076f51d8876b8aac99bff399 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu Jun 12 16:30:53 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Jun 12 16:30:53 2025 -0700 |
| tree | bb2b811de99774a25450539a950d7edd083d60f2 | |
| parent | 6ff0c15e5c7ac12d6d4cb10a25e7d7277bbf10a3 [diff] |
roll: third_party/pigweed eac2db8..3f4f714 (9 commits) 3f4f714:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297277 pw_kernel: Automated system generation cbf3839:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297741 third_party: Add hashlink crate 725cf2a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297740 third_party: Add toml crate bc77a6c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297895 docs: Add note about Tests-Not-Needed 4377109:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297793 pw_protobuf: Add `invalid` argument to generated *ToString() functions cbbdff1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297739 third_party: Add askama crate fb1869f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297734 pw_kernel: In presubmits, run lints last b85158a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297274 pw_i2c_mcuxpresso: Acquire and Release underlying clock c4afd9a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297795 pw_rpc: Skip flaky ubsan findings Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: eac2db8221f5f2..3f4f714a9366b6 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8712226574071790257 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I81eeb2c762b23182befaf0179e78033b3bde17fc Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/297952 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.