Google Git
Sign in
pigweed / pigweed / examples / da51f6f639192340df9e9e64d56d7b5b244eb128
commitda51f6f639192340df9e9e64d56d7b5b244eb128[log] [tgz]
authorAlexei Frolov <frolv@pigweed.infra.roller.google.com>Thu Oct 03 19:44:02 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Oct 03 19:44:02 2024 +0000
tree4cdc399466520d54000047acbeedb23ed8983085
parentc846c42907ce825279b50d5c9ba5f8fb79fa1c88 [diff]
roll: third_party/pigweed pw_rpc: Add callback writes to raw RPC call objects

This adds a new API to pw_rpc's RawServerReaderWriter and
RawClientReaderWriter which allows users to directly serialize their
RPC payloads to the RPC system's encoding buffer instead of a requiring
a copy from an externally-managed buffer.

This type of direct encoding buffer access is already possible through
the pwpb and nanopb RPC APIs through the use of callback members in
their generated structs. Enabling it in raw_rpc provides better parity
with these other protobuf libraries.

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239353
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Original-Revision: 8e2fc6cfe825631416043a972cdd93875562a4fd

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 02a68bb680ebdd..8e2fc6cfe82563
Roller-URL: https://ci.chromium.org/b/8735071176142972433
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I8008891b2fbacb084968b80900ab963a89bda128
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/239874
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: 4cdc399466520d54000047acbeedb23ed8983085
  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.