| commit | fb786878cd972f6e045719e78f303778fafe4ea4 | [log] [tgz] |
|---|---|---|
| author | Howie Peng <howiepeng@pigweed.infra.roller.google.com> | Sun Apr 27 21:14:57 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Sun Apr 27 21:14:57 2025 -0700 |
| tree | 5d3e17fd0f1332ddda411308a9dd44288240ecf4 | |
| parent | 7242622dd3e37cebb94eb009bccb88a60408f7aa [diff] |
roll: third_party/pigweed pw_rpc: Depend on mutex only if enabling PW_RPC_USE_GLOBAL_MUTEX Since we are not using pw_sync:mutex when disabling global synchronization, i.e., set PW_RPC_USE_GLOBAL_MUTEX, we should not ask for a mutex backend. The change introduces a constraint setting which is used to define the PW_RPC_USE_GLOBAL_MUTEX, and set up proper build dependency. Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286452 Tests-Not-Needed: Howie Peng <howiepeng@google.com> Original-Revision: b25f844d44052006b5d2f347e15954a597be0aa4 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: f36b192d1ad8c6..b25f844d440520 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8716376109870573441 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ibc614d99e6f0d22a98bfeccae4560789c1f64da3 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/286792 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.