Google Git
Sign in
pigweed / pigweed / examples / 389ba0ebc3813f3dbe38d51f3ba6b75d5b0b3c2b
commit389ba0ebc3813f3dbe38d51f3ba6b75d5b0b3c2b[log] [tgz]
authorAlexei Frolov <frolv@pigweed.infra.roller.google.com>Thu Oct 17 00:53:38 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Oct 17 00:53:38 2024 +0000
treef02f8463cc3e2c482560b0a39a44099147f42775
parent5f31042196cd2be939bd3eb639bdf4b1f05218e6 [diff]
roll: third_party/pigweed pw_protobuf: Force use of callbacks for oneof

pw_protobuf's message structures previously generated each of the
members of a oneof group as a separate struct member, allowing multiple
of them to be set to serialize semantically-invalid wire messages.

This replaces oneof struct member generation with a single callback for
the entire oneof group, allowing the user to encode/decode the desired
oneof field using the wire stream encoder and decoder.

The old oneof behavior is kept behind a protoc plugin flag to aid
downsteam migration. This flag is currently only activated in Bazel
builds.

Original-Bug: 373693434
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242392
Original-Revision: 205570386eac8fe6e0269b7fbbab1449eb565036

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 6ae64ef2889810..205570386eac8f
Roll-Count: 1
Roller-URL: https://ci.chromium.org/b/8733873920818124433
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I9f4aedbe302099453f0d54aa3052e11688c74ebb
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/242660
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>
1 file changed
tree: f02f8463cc3e2c482560b0a39a44099147f42775
  1. build_overrides/
  2. docs/
  3. examples/
  4. images/
  5. infra/
  6. libraries/
  7. targets/
  8. third_party/
  9. tools/
  10. .clang-format ⇨ third_party/pigweed/.clang-format
  11. activate.sh ⇨ bootstrap.sh
  12. .bazelignore
  13. .bazelrc
  14. .bazelversion
  15. .gitattributes
  16. .gitignore
  17. .gitmodules
  18. .gn
  19. .pw_console.yaml
  20. activate.bat
  21. banner.txt
  22. bootstrap.bat
  23. bootstrap.sh
  24. BUILD.bazel
  25. BUILD.gn
  26. BUILDCONFIG.gn
  27. LICENSE
  28. MODULE.bazel
  29. navbar.md
  30. OWNERS
  31. pigweed.json
  32. pyproject.toml
  33. README.md
README.md

Pigweed Sample Project

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!

Getting started

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

Environment setup

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

Building

All of these commands must be run from inside an activated developer environment. See Environment setup

One-shot build

To build the project, documentation, and tests, run the following command in an activated environment:

pw build

Automatically build on file save

Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:

pw watch

Typical workflow

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

More info and Examples

Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html.