| commit | 39a392e02023844bc3c30b5d2fee756b0f3cc1f9 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Fri Sep 13 23:30:37 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri Sep 13 23:30:37 2024 +0000 |
| tree | a74596d4ce131d46b7b8193ecc41108ce0d02f3c | |
| parent | 103fda7a9cf7bca98e2bf696d880858e01214454 [diff] |
roll: third_party/pigweed 9 commits 82759ccb711c3f3 pw_allocator: Check for room to split the first bl 62d79c9eb3b5120 pw_env_setup: PyPI version bump to 0.0.18 cac24bc90cf0c12 bazel: Update to rules_cc 0.0.10 9fb87e78e4c4177 pw_tokenizer: Add token domain support to Detokeni 22fa494c5680826 pw_env_setup: PyPI version bump to 0.0.17 40f756e2d3c40ee pw_toolchain: Make toolchain registration configur 08ff555993b8ab2 pw_tokenizer: Use domains in the Python tokens.Dat 7795cfc2d08139b pw_bluetooth_sapphire: Add riscv64 prebuilt 1b888ec9ed7c3f8 pw_multibuf: Add missing space to fix docs renderi https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: a60f57b2e1cea33..82759ccb711c3f3 Roller-URL: https://ci.chromium.org/b/8736868854494237441 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Icf393578f41bc24e490cddc1fce8eb3105356f41 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/235695 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.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.