| commit | b8bf250c97cb00a67bd07956cf0fa29d0ee1c571 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Apr 23 21:04:08 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Apr 23 21:04:08 2024 +0000 |
| tree | fabc3d0725748209eaae5043ebed3029214df2ec | |
| parent | 9c16adc29f470d68c1712a611856acb0349c2541 [diff] |
[third_party/pigweed] Roll 6 commits a9707e739fefa6f pw_allocator: Fix SynchonizedAllocator data race 3d2be38e99af311 pw_presubmit: Remove --verbose_explanations flag 69675d0eddb6ce8 pw_transfer: Implement adaptive windowing in Java 0ce38d914d7f6de pw_presubmit: Use _LOG global for logging 1e72e7e55cef252 pw_presubmit: RST format updates d01aa29f9f9e113 pw_presubmit: Allow disabling hook creation https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: bc6388fd60ff21b..a9707e739fefa6f Roller-URL: https://ci.chromium.org/b/8749833573077110257 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I2776291775a99f3de425b05b921afa2c8fc6f371 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/206012 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.