| commit | 6ebeabe82f99dbdaf52fe7a7d30b672a6d3eaae8 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Fri Apr 26 00:05:51 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri Apr 26 00:05:51 2024 +0000 |
| tree | 16ffc5a0e8a13306cc171342e509dd002061b9b7 | |
| parent | e36a858a40df9c4eca5c5d381586b5dc38e149a5 [diff] |
[third_party/pigweed] Roll 6 commits 5a8cde71ecadfd8 pw_rust: Fix Rust tokenized logging example 144ac20a8cbfa3f pw_module: Include :authors: in generated SEED fil 55f718e19c789f7 pw_format: Better explain core::fmt whitespace par a56e966f863779b pw_build: Fix using pw_cc_blob_library target in e de74460373ec62a pw_string: Add ToString for iterables cda2a749853a894 SEED-0128: Claim SEED number https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 1807af542686e6d..5a8cde71ecadfd8 Roller-URL: https://ci.chromium.org/b/8749640952089712593 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ie9e36e17b8031f4e82b66b7c76206ab9e0b8af87 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/206791 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.