roll: third_party/pigweed roll: luci cas From git_revision:0014f9f80c1083ffa01d7787d8571a8f689aa5e7 To git_revision:00d484f7e6876a2454a633b0afcb18186cd3f3ef swarming From git_revision:0014f9f80c1083ffa01d7787d8571a8f689aa5e7 To git_revision:2f3bde27292bd2267fd4e7dd54cd6d661b865be5 logdog From git_revision:0014f9f80c1083ffa01d7787d8571a8f689aa5e7 To git_revision:1e8a86e7a2aab9090d884944ab04db3cb717a23a luci-cv From git_revision:2060ec0d86ae1880de07f3d80f7c3f2b93b8ebc1 To git_revision:1e8a86e7a2aab9090d884944ab04db3cb717a23a Roll-Count: 4 GitWatcher: ignore Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/480965 Original-Revision: 17fee2ef9e6afdfe63d0f484a1826e38e8ca176d Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 61529e187fafef..17fee2ef9e6afd Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8670136980398186465 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I38e70d265578abd2b7bba1777f9d620cfe6e6934 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/481026
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.