Google Git
Sign in
pigweed / pigweed / examples / 185b80be7836e467ffd8de60d4a481cef2afe277
commit185b80be7836e467ffd8de60d4a481cef2afe277[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Sat Jun 01 00:33:17 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sat Jun 01 00:33:17 2024 +0000
treee8269d594e92ff7e80a4b25ae5710f228f7e7084
parent71fabbbe2db9e1f5a7b4d184b43da2ce571b7439 [diff]
[third_party/pigweed] Roll 14 commits

eee966337afe905 pw_log: Cast log level to int32_t
962d662171f05d0 pw_transfer: Always terminate transfers on stream
66c06bc9f876fc1 docs: blog: Bazel feature flags
7a6837d6e7ca33d pw_digital_io_linux: Add "watch" command
1ed69ae399e31f7 pw_digital_io_linux: Add support for input interru
e56d63cfa56952f pw_digital_io_linux: Move examples out to compiled
2fd1e9cc714a565 pw_digital_io_linux: Update mock_vfs
a07f9d1b43ebf67 pw_digital_io_linux: Add log_errno.h
9e5f85b2ed9593a pw_system: Mention that extra libs need alwayslink
96313b7cc138b0c pw_malloc: Add allocator backends
93fa287dc5010cf targets/rp2040: Add pico/debug probe filtering fla
bdc50b62ca4c11a pw_log_string: Set default log backend
da28a3e5e0b0048 pw_stream_uart_mcuxpresso: InterruptSafeWriter exa
1aa9d51028fcbc3 pw_stream_uart_mcuxpresso: Stream example

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed Rolled-Commits: a9a64a72393ed20..eee966337afe905
Roller-URL: https://ci.chromium.org/b/8746377567885521777
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0b079995d10e90c7ca90e2a202f88b4616cbc37a
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/213171
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: e8269d594e92ff7e80a4b25ae5710f228f7e7084
  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.