| commit | 71fabbbe2db9e1f5a7b4d184b43da2ce571b7439 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Fri May 31 21:33:17 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri May 31 21:33:17 2024 +0000 |
| tree | 05de620d8a1e67f2e830d7bdc9c4475c8330db82 | |
| parent | 70b2b2d5378ae5a03f19594fa86f8835c62541c9 [diff] |
[third_party/pigweed] Roll 7 commits a9a64a72393ed20 pw_stream_uart_mcuxpresso: Use clock tree 57310630f125c37 pw_clock_tree: Introduce ElementController class 1a672e2605ac5a4 pw_clock_tree_mcuxpresso: Fix source set name and 1d491c30feb54ee pw_clock_tree: Fix source set name and visibility aaa553c8693be3d pw_stream_uart_mcuxpresso: DMA stream example e8dcc48f4c5e8aa mimxrt595: Upgrade to SDK_2_14_0_EVK-MIMXRT59 1f6ad3a910c7cb0 pw_multibuf: SimpleAllocatorForTest https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 7bb5a76cced7e77..a9a64a72393ed20 Roller-URL: https://ci.chromium.org/b/8746388897609133457 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I7ec84a7af0880268ad9c0596671f0df736308506 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/213031 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Bot-Commit: 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.