roll: third_party/pigweed 55e8228..8238695 (8 commits) 8238695:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/439193 pw_kernel: Add mailbox support to host side tooling e3935a4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/452712 pw_i2c_mcuxpresso: Add check for reading too few bytes 1e2949f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/436513 pw_kernel: Add a debug mailbox library 6468319:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/451033 pw_kernel: Sleep bootstrap thread in userspace tests 5ff0d19:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/454105 pw_ide: Release v1.11.1 e177c4c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/452652 pw_ide: vscode: Fix Rust target selection and rust-analyzer 9c6a517:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/450215 pw_kernel: Trace syscalls when SYSCALL_TRACE is enabled 9bd6c00:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/452353 pw_ide: Exclude test files from webview TypeScript config Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 55e8228820d016..823869564abc12 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8673628098520465265 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: If6496415c322b998b02c977b081ae4d45769a7bf Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/454305
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/examples/+/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/examples
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.