roll: third_party/pigweed 968ae1b..5282cf3 (3 commits) 5282cf3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/336161 pw_kernel: Move memory region abstration into its own crate d0c3443:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/338599 pw_kernel: Fix `app_package` for downstream repos 7776f6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/338556 pw_trace_tokenized: Add transfer_handler tests Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 968ae1b73c3637..5282cf333058d6 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8699659348382611313 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Idb7b319e261ac951faa66d04b1ed2cf5493749dd Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/339252 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> 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.