Google Git
Sign in
pigweed / pigweed / examples / 4834076fb69a5914d2cbfba631244241a14609d5
commit4834076fb69a5914d2cbfba631244241a14609d5[log] [tgz]
authorAnthony DiGirolamo <tonymd@pigweed.infra.roller.google.com>Tue Oct 08 01:20:21 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Oct 08 01:20:21 2024 +0000
tree2101cb97fc38246ade891fc30453baf869818217
parent6095166a4693a84074ec6c2a085c82d93c8034a1 [diff]
roll: third_party/pigweed pw_build: Fix pw_python_venv generated requirements

pw_python_venv was always adding the //pw_build/py gn target to the
list of dependencies to base the generated requirements on. This is
usually not an issue if pw_build is included. However if it isn't
needed extra 3p deps were always getting added from pw_build
regardless.

For example if a venv only needed //pw_docgen/py and //pw_status/py
the generated_requirements would include all these extra packages due
to pw_build being added in along with all their 3p deps:

  //pw_arduino_build/py:py
  //pw_build/py:py
  //pw_cli/py:py
  //pw_config_loader/py:py
  //pw_docgen/py:py
  //pw_env_setup/py:py
  //pw_package/py:py
  //pw_presubmit/py:py
  //pw_status/py:py
  //pw_stm32cube_build/py:py

This change fixes it so only these two are added:

  //pw_docgen/py:py
  //pw_status/py:py

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240792
Original-Revision: 87f43fec003b4befd74b2362962a76dff7105253

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 29fc404197899d..87f43fec003b4b
Roller-URL: https://ci.chromium.org/b/8734687646195417345
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I4e722c19523147486c4a047a0779d23acb599d35
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/240622
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: 2101cb97fc38246ade891fc30453baf869818217
  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.