Google Git
Sign in
pigweed / pigweed / examples / 77b917f072978f49b21a0d68cb5b0dd76ddaeb3a
commit77b917f072978f49b21a0d68cb5b0dd76ddaeb3a[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Mon Apr 14 18:53:29 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Apr 14 18:53:29 2025 -0700
tree05bfde77fb8881c7ab4a27e13ac75cfab514d25b
parentbcff1d215e7f9a95f9402a98df5b2ae5ccbcf40e [diff]
roll: third_party/pigweed baa8c72..4fa03e9 (8 commits)

4fa03e9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283872 pw_base64: Function for exact Base64 decoded size
cb60cea:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283798 pw_base64: Ignore padding bytes when decoding
69c343a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281836 pw_ide: Relocate vscode dependencies from compile commands generator
5ece86a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281835 pw_tokenizer: Improve parse_message tool
6b06aa9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282939 pw_kernel: Don't ignore GN files in pw_kernel
5b7d443:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283795 bazel: Roll Fuchsia SDK
59094f8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283797 bazel: Move host_platform into MODULE.bazel
10bb8b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279741 pw_ide: Trigger refresh manager on non-bazel compile command refresh

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: baa8c724cf679d..4fa03e9fd2a527
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8717562766799634449
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0090b889df47dbdee953bede03c6648384bef9d5
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/283773
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: 05bfde77fb8881c7ab4a27e13ac75cfab514d25b
  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. .clang-tidy
  16. .gitattributes
  17. .gitignore
  18. .gitmodules
  19. .gn
  20. .pw_console.yaml
  21. activate.bat
  22. banner.txt
  23. bootstrap.bat
  24. bootstrap.sh
  25. BUILD.bazel
  26. BUILD.gn
  27. BUILDCONFIG.gn
  28. LICENSE
  29. MODULE.bazel
  30. navbar.md
  31. OWNERS
  32. pigweed.json
  33. pyproject.toml
  34. 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.