roll: third_party/pigweed 74a4003..a4aea60 (11 commits)

a4aea60:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310995 pw_ide: npm audit fix vulnerable packages
aeb50b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310994 doxygen: Align title with main site
5e8f857:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310896 .gemini: Ask for boolean in review prompt
1043464:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309474 python: mypy fixes
fdb4334:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310992 pw_review: Harden JSON parsing
e1d3a5e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310895 doxygen: Enable light theme
1bd21aa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310893 pw_review: Add a test for review.py
baac171:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310856 pw_review: Add debug output when parsing fails
0bc94e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310892 pw_review: Extract from pw_cli
23ff7b9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310633 docs: Remove Sense doc redundancy
cdb89fa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308412 pw_bluetooth_sapphire: Support LeSubEventCode in AddLEMetaEventHandler

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 74a4003249b4c8..a4aea60ec666c5
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8707253901040183553
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I10212a1ffae005b6a36a18ebbd439067471ea8a2
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/311152
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: 118d92e08697295005fad6c7ada4fce30807a238
  1. build_overrides/
  2. docs/
  3. examples/
  4. images/
  5. infra/
  6. libraries/
  7. targets/
  8. third_party/
  9. tools/
  10. .bazelignore
  11. .bazelrc
  12. .bazelversion
  13. .clang-tidy
  14. .gitattributes
  15. .gitignore
  16. .gitmodules
  17. .gn
  18. .pw_console.yaml
  19. activate.bat
  20. banner.txt
  21. bootstrap.bat
  22. bootstrap.sh
  23. BUILD.bazel
  24. BUILD.gn
  25. BUILDCONFIG.gn
  26. LICENSE
  27. MODULE.bazel
  28. navbar.md
  29. OWNERS
  30. pigweed.json
  31. pyproject.toml
  32. 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.