| commit | e787e783941f89133ab95124d355b9abb522a5de | [log] [tgz] |
|---|---|---|
| author | Armando Montanez <amontanez@pigweed.infra.roller.google.com> | Wed Oct 02 23:03:23 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Oct 02 23:03:23 2024 +0000 |
| tree | 02fc8adbd35f3caff2643ba318e57839e94c278b | |
| parent | cf3cc9db7044cbedf4219d16695ba46e66e7631e [diff] |
roll: third_party/pigweed pw_build: Break apart pigweed.bzl Overtime, Pigweed unintentionally grew a `pigweed.bzl` file that ended up being a grab-bag of various Bazel rules. This change breaks up this file to mirror GN by moving rules into their own individual files, moving to different modules where appropriate. Original-Bug: b/370792896 Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239133 Original-Revision: 53b16cd8d2907855b13bec9159286927de602a72 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 547e0582fa65c3..53b16cd8d29078 Roller-URL: https://ci.chromium.org/b/8735149254612241441 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I06f91fb8066f9971a776091fd5f65aeedc864fc4 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/239632 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>
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!
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
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
All of these commands must be run from inside an activated developer environment. See Environment setup
To build the project, documentation, and tests, run the following command in an activated environment:
pw build
Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:
pw watch
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
Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html.