| commit | 3dc8977a672c9e54efec0fff4b076c62d22fe3c1 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Wed Feb 28 02:19:23 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Feb 28 02:19:23 2024 +0000 |
| tree | b153b06c03462976156275e4cf75564fae1db020 | |
| parent | ba7841f3c24903ddbb3a6ae728a9fe46976b65d8 [diff] |
[third_party/pigweed] Roll 9 commits 75809db522a27fe pw_allocator: Add missing dep 2a3d10804995f5b pw_tokenizer: Fix missing bazel filegroup 518bb002c55ebb9 pw_async2: Add converting constructors to Poll 6b0b9c2f3ca1b6c pw_stream_uart_mcuxpresso: Implement DoRead DMA 3ca23db2114f542 pw_stream_uart_mcuxpresso: Implement DoWrite DMA 6992b4612b3a18a pw_stream_uart_mcuxpresso: Implement init / deinit fef14dcb5e4615e pw_sync: Allow implict conversion when moving Borr b10b18a6800a187 pw_allocator: Use BlockAllocator instead of altern 73892fa16303e22 pw_stream_uart_mcuxpresso: USART DMA scaffolding https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 837563b4de97b83..75809db522a27fe Roller-URL: https://ci.chromium.org/b/8754887217241639505 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I69c3e6379b12fe281fdf9696d7138e4a71cf7c00 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/194510 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.