Google Git
Sign in
pigweed / pigweed / examples / 06da63021ea8021a2891a2d616d970d2e4dea9a4
commit06da63021ea8021a2891a2d616d970d2e4dea9a4[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Jul 18 01:54:15 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Jul 18 01:54:15 2024 +0000
treebb3e828bbb7b1604a57d6f833a6127b08b90a35c
parent3dcffef5b84e2d64938dad6fc7af001e001e002c [diff]
roll: third_party/pigweed 9 commits

4e49c9a4d73cd65 roll: rules_python
e4e974a53ee236d pw_bluetooth_sapphire: Use pw_bytes for endianness
cbdf4ece80b860e pw_bluetooth_sapphire: Cleanup WritePageScanActivi
31314575c7d54b5 pw_bluetooth_sapphire: Cleanup into shared test fi
f5bb47bd0316e6a pw_bluetooth_sapphire: Cleanup WriteLocalNameRespo
5592c7588a11a66 pw_bluetooth_sapphire: Fix camel case for CIS acro
6f990918d3f2ee6 pw_bluetooth_sapphire: Cleanup Inquiry command pac
003bbe28674612a pw_bluetooth_sapphire: Implement AcceptCis()
d01cc5df086d910 pw_chrono_freertos: Work around no std::unique_loc

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed Rolled-Commits: 7bd3905ad725850..4e49c9a4d73cd65
Roller-URL: https://ci.chromium.org/b/8742114438662776449
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0485ef66560e92db7739d0f19fd7f648024d2230
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/223802
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: bb3e828bbb7b1604a57d6f833a6127b08b90a35c
  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. navbar.md
  29. OWNERS
  30. pigweed.json
  31. pyproject.toml
  32. README.md
  33. 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.