| commit | 95be28f1183de533835735c86f72675dcf103e5e | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Fri Oct 18 18:51:32 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri Oct 18 18:51:32 2024 +0000 |
| tree | ad53cac70aee4ef17c02b1242f8e373cafd68822 | |
| parent | d029af432f0a5116a81474b020b3422833b31f8d [diff] |
roll: third_party/pigweed 9c37b72..f66f4e4 (5 commits) f66f4e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242639 pw_build: Add Python Bazel tests 273ade2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242638 pw_presubmit: Add Python Bazel tests 2097d2e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242928 pw_protobuf_compiler: Make oneof_callbacks a per-library setting 60572e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242637 pw_env_setup: Add Python Bazel tests e5db91d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238432 pw_thread: Migrate to Thread::id Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 9c37b722d9a807..f66f4e473e6620 Roll-Count: 1 Roller-URL: https://ci.chromium.org/b/8733715686527508401 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ie5a43205ed899daf00bf4d662622cb87c8e331d9 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/243254 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> 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.