| commit | 579cd96b1b8c9a8062570216a7bf6cdab7593de5 | [log] [tgz] |
|---|---|---|
| author | Austin Foxley <afoxley@pigweed.infra.roller.google.com> | Wed Oct 09 19:31:47 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Oct 09 19:31:47 2024 +0000 |
| tree | 7c08a735299daef54d726ab580e344a0a48ce672 | |
| parent | 24828180cbec613805c5f71664748bd8121c36c8 [diff] |
roll: third_party/pigweed pw_protobuf: Support directly specifying options file locations Replace the existing import-prefix arg to pwpb protoc plugin with an option to directly specify the location of any .options files to load from. The import-prefix option was added to try and find options files whose proto paths had been modified via the import_prefix bazel attr. This worked fine as long as you were careful to place your options files in a place where the existing search paths could find them. We've found it's easy to break this arrangement if the real path of the .options file isn't prefixed by the virtual import path of the proto. This could be fixed by a further complicated dance of constructing search paths that the plugin will then further mangle to check if the options file exists. This CL instead directly specifies the location of any options files for the pwpb plugin, while leaving in place the existing search path logic required for nanopb options files. Original-Bug: https://pwbug.dev/253068333 Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240833 Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Original-Revision: 6efc99b3ee854dd54a0b1465d9014c54e01b21b9 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 4321a46654fae2..6efc99b3ee854d Roller-URL: https://ci.chromium.org/b/8734528369919969425 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ia0d97addab3b11f8711582151853fbdc06b3c5f5 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/241153 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.