Google Git
Sign in
pigweed / pigweed / examples / 362a3c2e43867b8802c26e4b30abdef6297e1d8a
commit362a3c2e43867b8802c26e4b30abdef6297e1d8a[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu May 16 00:19:49 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu May 16 00:19:49 2024 +0000
tree634006e66e0cc98860a027b6520cc528529fb23a
parent82252db036120bce92ebce1684081e633d4eb1ba [diff]
[third_party/pigweed] Roll 9 commits

843bd1cf3b198a4 pw_transfer: Add tests for GetResourceStatus
44c6eb538a67ad6 pw_env_setup: Bazel support for config_file
137e8b7fe7ade32 bazel: Ignore reformatting change in git blame
8c39d4026adc12f pw_presubmit: Auto fix unsorted-dict-items
6b1323857437a22 third_party/perfetto: Rename proto targets
7c4acea38d79a7f pw_toolchain: Fix typos in newlib_os_interface_stu
54a35ecd0d457ca pw_cpu_exception_cortex_m: Add error flag masks
42a82886e1fa154 pw_bloat: Add padding to utilization
c7128f5797ce9d4 bazel: Fix unsorted-dict-items instances

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed Rolled-Commits: 1f9748d17b29edc..843bd1cf3b198a4
Roller-URL: https://ci.chromium.org/b/8747827970208522193
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I8e3f6fd35c4a3ee321d328512e14110db89451d7
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/210131
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 634006e66e0cc98860a027b6520cc528529fb23a
  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. activate.bat
  20. banner.txt
  21. bootstrap.bat
  22. bootstrap.sh
  23. BUILD.gn
  24. BUILDCONFIG.gn
  25. LICENSE
  26. navbar.md
  27. OWNERS
  28. pigweed.json
  29. pyproject.toml
  30. README.md
  31. WORKSPACE
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.