Google Git
Sign in
pigweed / pigweed / examples / 4f09edeb7744321c3f8586f3f99e8ad34eeb1e0f
commit4f09edeb7744321c3f8586f3f99e8ad34eeb1e0f[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Tue Jan 14 16:18:46 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Jan 14 16:18:46 2025 -0800
treefb73dccc3a677c50d11b7c7dcf696c61400d57c6
parent49535c675cc7fcad091f7ac834a01de1b5f9da1d [diff]
roll: third_party/pigweed a67cc22..fec7e11 (10 commits)

fec7e11:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260415 pw_rpc: Introduce Client.createLegacySingleCall to simplify migration
c2de658:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260273 pw_rpc: Temporarily ignore call IDs by default in Java client
587b9d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260515 pw_watch: Watch for changes in .java files by default
1ca8d34:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260412 pw_*/docs.rst: Add pigweed-module:: directives to docs.rst files
29f2476:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260513 pw_docgen: Treat doc metadata tagline as optional
8ae255e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/259713 pw_web: Remove old react webconsole example app
86cb968:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260313 pw_sync: Split TimedBorrowable from Borrowable
b3361cf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260472 pw_web: Run npm audit --fix and also fix jest config
a90ad78:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/253267 pw_tokenizer: Create generic macro for a nested token format
8c5043f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/253972 pw_tokenizer: Update regex for nested arg domains

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: a67cc226162325..fec7e1118fc2c4
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8725722499236972689
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I4470506a6c7d165c3878c2c4b980dcecd017c404
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/260496
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: fb73dccc3a677c50d11b7c7dcf696c61400d57c6
  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.