| commit | 1b308d8d2ec0985910e61a097072364688d211da | [log] [tgz] |
|---|---|---|
| author | Rob Mohr <mohrr@pigweed.infra.roller.google.com> | Fri Feb 14 20:45:58 2025 -0800 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri Feb 14 20:45:58 2025 -0800 |
| tree | b829a19b7bf9cab75fcbd705e1551de0c614a1ed | |
| parent | 490dee00a63942c35c271ded500260bbce4f2883 [diff] |
roll: third_party/pigweed pw_env_setup: Remove gsutil from PATH Keep the LUCI gsutil executable in the environment, but move it to where it won't be in PATH. It's needed for coverage builds, but it shouldn't be used by developers except explicitly. Original-Bug: b/396199506 Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/268153 Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Original-Revision: 264303d972bb23b01842659e3357791d3ae23f77 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 416b03b72216ec..264303d972bb23 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8722897141536166529 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ieae183d021afa7cf3a52280201369f8599e9724e Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/268194 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>
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.