commit | e73d1df92ef6a435741e7bdb2b0844a3d5aad5bd | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu Jul 25 01:34:04 2024 +0000 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Jul 25 01:34:04 2024 +0000 |
tree | 954dce2835019c1566f1b52a3da741a29dc6fc76 | |
parent | b8b6814aac42909bbbe49cf2b8c7d1ebb2b432b1 [diff] |
roll: third_party/pigweed 11 commits 4f2ff81bb96a02f pw_async2: Add CoroOrElseTask a635512a270241c pw_async2: Add Task::IsRegistered e82bb11ee931b92 pw_console: Fix RPC autocompletion in web kernel 4d38f4611153ced emboss: Update emboss repo to v2024.0718.173957 a158415a5c07e71 pw_system: Enable crash handler in async system 4b3e53050bbc33c pw_ide: Update vendored tools on extension update d04920d78848a69 pw_async2: Add Coro::Empty 1c308d70f947c93 emboss: Run python with optimization on 2cd7928833a7590 pw_web: Add repl intro message and title param 319b183d63d4cd0 pw_ide: Use vendored Bazelisk in recommended confi c369d01270042fc pw_ide: Improve VSC settings interface https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 54b1551fabecd43..4f2ff81bb96a02f Roller-URL: https://ci.chromium.org/b/8741481560827310257 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I9cf80611cb3d94f576ecddbf32cab6e47c3d4fbd Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/226035 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.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
.