| commit | 8d174222f4490a8474ea362139e676fb89e34853 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Mar 18 21:47:31 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Mar 18 21:47:31 2024 +0000 |
| tree | 5e5ed0809250fd260ccfa9d6668307bb77f88666 | |
| parent | c05df1ae5f28b98604d6ff5039b242e8f12eea9e [diff] |
[third_party/pigweed] Roll 7 commits fa8e6c497fa2268 pw_multibuf: Add stream implementation 5c8a3f79b83ef56 pw_channel: Remove max_bytes argument from ReadPol c3965666758921d pw_multibuf: Add empty() function 4fb184103c05d01 pw_env_setup: Update min Python version to 3.10 b2a514a4ae0d2c5 bazel: Remove the deprecated pw_cc_facade macro 2d735c7ce46d1c0 pw_spi: Update Android.bp to conform with new styl 1f4a92c0cf89704 pw_unit_test: Add duplicate test case https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 088229ce2d5325e..fa8e6c497fa2268 Roller-URL: https://ci.chromium.org/b/8753096935190237553 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I2c717eefe6128afb1cebb3c4c4894b9933f5e25b Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/197470 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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.