| commit | 49535c675cc7fcad091f7ac834a01de1b5f9da1d | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Jan 14 13:18:28 2025 -0800 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Jan 14 13:18:28 2025 -0800 |
| tree | 0618595ec209b5274ef70c684bbb12f53834097a | |
| parent | 2711c08770bbc1eda8367e509824476dc11ee9de [diff] |
roll: third_party/pigweed 2b3049b..a67cc22 (8 commits) a67cc22:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260094 pw_*/docs.rst: Remove outdated "under construction" notices 8e0e0a0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260093 pw_presubmit: Use CQ cache instance 41b6f9a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260014 pw_digital_io_mcuxpresso: Remove deprecated headers c3fc5a1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260432 pw_format: Fix use of type_alias_impl_trait e977933:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260312 pw_sync: Refactor borrow tests 3d3c663:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255062 pw_toolchain: Add cargo to Rust toolchains bdc5263:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260216 pw_bluetooth_sapphire: FakeController code cleanup 5f53ccb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260013 pw_digital_io_mcuxpresso: Reorganize PINT support Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 2b3049b1573b8c..a67cc226162325 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8725733801127211921 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I6085926e10faa9e6ff30e6dbcc74ac662160c5b6 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/260374 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.