[third_party/pigweed] Roll 8 commits 006ab828252ebef pw_ide: Support including and/or excluding targets 54365f77ab968de pw_presubmit: Refactor Python Black formatter supp f3efc84d58d607a pw_presubmit: Refactor Bazel formatter support 7ad13e08167f560 pw_bluetooth: Add example of using to_underlying d05115caa2f47db pw_build: ProjectBuilder documentation 0ee6ca26f6a11aa pw_presubmit: Refactor GN formatting support ff16d3745ee4b50 pw_presubmit: Make ToolRunner capture stdout/stder 8531e52bc0e149d pw_emu: Fix a TypeError in TemporaryEmulator https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 6d2f01d2acec72e..006ab828252ebef Roller-URL: https://ci.chromium.org/b/8752179102052457729 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I2fef223e77a27efefbf8e2c8c0912b722a6563f4 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/200990 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.