Google Git
Sign in
pigweed / pigweed / examples / 6095166a4693a84074ec6c2a085c82d93c8034a1
commit6095166a4693a84074ec6c2a085c82d93c8034a1[log] [tgz]
authorTed Pudlik <tpudlik@pigweed.infra.roller.google.com>Mon Oct 07 19:23:45 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Oct 07 19:23:45 2024 +0000
tree62fa7664c974fe57f6d8b26c2495c670ed416beb
parentf35e21a69ac056fe118f71a652732783071c8be7 [diff]
roll: third_party/pigweed Revert "pw_system: Don't use implementation_deps"

This reverts commit 65c56255b82a13cc2b521b12cedf165b696261b5.

Reason for revert: Implementation deps now supported internally.

Original change's description:
> pw_system: Don't use implementation_deps
>
> This is just a temporary mitigation for a lack of support for
> implementation_deps internally. I hope to revert this within weeks.
>
> Original-Bug: 304374970
> Original-Bug: 356667663
> Change-Id: I16cc22c36960cb53676591709f5402f2a8032370
> Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/226977
> Pigweed-Auto-Submit: Ted Pudlik <tpudlik@google.com>
> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
> Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
> Reviewed-by: Armando Montanez <amontanez@google.com>

# Not skipping CQ checks because original CL landed > 1 day ago.

Original-Bug: 304374970
Original-Bug: 356667663
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/227601
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Original-Revision: 29fc404197899dd272320c336f944b91e2140f09

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 35c10c46e5761f..29fc404197899d
Roller-URL: https://ci.chromium.org/b/8734710213875995249
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I5ccfbbaa0e8d67b2792534995fbb1f7c28af5db2
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/240617
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 62fa7664c974fe57f6d8b26c2495c670ed416beb
  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.