roll: third_party/pigweed fba6e89..d0d713b (8 commits) d0d713b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/483329 pw_async2: Update CoroTask and FallibleCoroTask as FutureTask aliases 1e59ffb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/489790 pw_ghish: Add first-class draft comment support 65e01a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/489849 pw_ghish: Add Change-Id retention and stack push guards 351c34a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/488949 pw_ghish: Tighten docs and CLI comparison df7bdbe:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/488409 pw_ghish: Add gh hook subcommand for agent and Git hooks 8cbe2be:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/490232 pw_enum: Move ToString to EnumTraits and add has_enum_to_string_v c8fe560:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/490179 pw_async2: Use PW_NO_INLINE to prevent coroutine stack allocation 8564288:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/489209 pw_rpc2: Add why doc and RPC1 vs RPC2 comparison Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: fba6e895c2a7b6..d0d713bbd869c5 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8669199078509509249 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I48dca154beeb85abae0fad5e9f4af3c8c0c29a99 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/490471
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.