commit | c6863dd623ac5e8e117c80bef4eaa57f8255c237 | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed.infra.roller.pigweed-service-accounts.iam.gserviceaccount.com> | Sun Mar 16 08:18:39 2025 -0700 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Sun Mar 16 08:18:39 2025 -0700 |
tree | ef2137fdddf4313686fc1d8d22569076d3e4b5eb | |
parent | b72b53cbe8c53f0a214f9e679fd65961bae0a23e [diff] |
roll: third_party/pigweed roll: luci bb From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:0116693211c2d2f947acb9977133a516e31d1e13 luci-auth From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:0116693211c2d2f947acb9977133a516e31d1e13 gerrit From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:036d16b462ac8941d3acc3c71edae733cb9bfd5c gitiles From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:036d16b462ac8941d3acc3c71edae733cb9bfd5c cas From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:0116693211c2d2f947acb9977133a516e31d1e13 led From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:0116693211c2d2f947acb9977133a516e31d1e13 swarming From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:0116693211c2d2f947acb9977133a516e31d1e13 logdog From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:0116693211c2d2f947acb9977133a516e31d1e13 prpc From git_revision:02552fa3896db64f2cd0c5c825ea562281913334 To git_revision:0116693211c2d2f947acb9977133a516e31d1e13 luci-cv From git_revision:02fc02109d481b268f15863a3bb07c98d1c06961 To git_revision:036d16b462ac8941d3acc3c71edae733cb9bfd5c Roll-Count: 10 GitWatcher: ignore Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/276235 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Original-Revision: 6fd6d5666f52eb394ba49a5d77aafe7123af937f Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 2221585beb9b33..6fd6d5666f52eb Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8720229951296076241 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I56399dcd1fbefb542918aa7a6fdb908d8acaf927 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/276166 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.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
.