roll: third_party/pigweed 219a3d8..5a5e4e2 (9 commits) 5a5e4e2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/501273 pw_ide: Traverse Fuchsia package attributes in compile commands aspect 44ab21d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/500319 pw_ghish/worktree: Batch Gerrit queries in wt list 01d42a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/504245 pw_rpc2: Strengthen client close and call reader tests 895db44:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/502446 pw_allocator: Add AbstractPool 00ca930:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/491671 pw_ghish: Add --nightly and --submit-at flags for Gerrit Flows 6bd8dc9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/500754 pw_varint: Fix 64-bit overflow handling and optimize decoding 05e266e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/504125 pw_bluetooth_sapphire: Use ScopedGlobalLogger ffb0d66:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/501033 docs: Fix C/C++ API reference links cd222a3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/504046 pw_rpc2: Make status enum library public Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 219a3d8b6c2b33..5a5e4e2b9250d9 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8667840675761002577 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ib4667af7fcc22716623b325549a35e68ba1b6d98 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/504445
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.