roll: third_party/pigweed b19c2b0..6317475 (6 commits) 6317475:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/303955 docs: Init Doxygen customizations 1b6f00c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/303972 pw_kernel: Update vscode docs to allow extra error output bcf321e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304093 pw_build: Remove obsolete incompatible_use_toolchain_transition 1b91b8b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295552 pw_rpc: Log ChannelOutput::Send() errors at the ERROR level fecaf14:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304012 docs: Update //docs paths ec97141:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304092 docs: Remove test string Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: b19c2b0bdbbe44..63174757bbb91b Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8709774140775373969 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: If095632d7b582bcddb4aeaeee28286f47dbe6829 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/303909 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: 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.