| commit | 3b35a86b9a5bd08ddb0eddc4b2c7ee79d32a4b81 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu May 08 17:43:53 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu May 08 17:43:53 2025 -0700 |
| tree | d4a8f621c3a12d70216a6e82ae84fe6a469aeb82 | |
| parent | d90fd11b3065b110b931cbaed1839b0dd704b78b [diff] |
roll: third_party/pigweed babceb1..0964137 (5 commits) 0964137:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289392 pw_module: Do not generate references to pigweed.bzl b137011:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286932 pw_async2: Support optional task names 2d02a6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289873 pw_hdlc: Workaround for PRIu64 newlib error 98be709:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287293 pw_thread_zephyr: Implement yield backend e9aa33b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287642 pw_thread_zephyr: Add zephyr hooks to pw_thread_zephyr backends Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: babceb1b3c0624..0964137f43f23b Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8715392881181215633 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I8d16a7e2604c6e36105d6dbe660c86e573ce01ee Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/289797 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.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.