Google Git
Sign in
pigweed / pigweed / examples / c0a84ed0848940d7dc84aaf317e9c9537c28b0e9
commitc0a84ed0848940d7dc84aaf317e9c9537c28b0e9[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Wed Nov 13 17:37:28 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Nov 13 17:37:28 2024 +0000
tree14a1de58bc8d175b3927c8cebb04c42ab4c63c14
parent85d177dd973744801b4b9e30e30b9a976a5f6d0d [diff]
roll: third_party/pigweed c99ca8a..b9b9135 (8 commits)

b9b9135:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248312 pw_bluetooth: Format emboss files
94e2314:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243532 pw_tokenizer: Add Detokenizer::FromElfFile
8ee7879:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/244893 pw_elf: Add ElfReader
a020d35:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248381 pw_protobuf_compiler: Specify flags for generate_proto.py
6aadd54:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236236 pw_spi: Finalize non-Virtual interface on Initiator
a703dc3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/244892 pw_elf: Create new module
a30e972:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248173 pw_bluetooth_sapphire: Use EmbossEventPacket in CommandChannel
c5d3d97:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245113 clang-tidy: Make [[deprecated]] a warning instead of error

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: c99ca8ae0a441b..b9b913515fcbec
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8731364975920822945
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I4d63a32c13cae5255f3b9b5752cebb83f741894e
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/248632
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: 14a1de58bc8d175b3927c8cebb04c42ab4c63c14
  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.