| commit | 2d346dd9b6243c54f60e31dfc3c94db91d94e5be | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Thu Feb 15 22:17:13 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Feb 15 22:17:13 2024 +0000 |
| tree | 6152e03df37e6616240c85dbdcc1623f9a112bd5 | |
| parent | a0e82a3f4e5f3dc31db794359a20c10c76c6a13d [diff] |
[third_party/pigweed] Roll 10 commits 63903b4f24e9122 pw_spi: Correct full-duplex behavior of linux_spi ff7e7a78ce968db build: Use correct host_cpu when disabling docs on 987b0a0f0f8f0d7 pw_string: Add ToString for std::optional e7814b76f3ebcc3 build: Remove docs from default build on Arm Macs 47fb4b3f1fd0a60 zephyr: Change the pinned Zephyr commit f61fec222738a06 pw_tokenizer: Fix link breakage on linux 9ba0e2a6c10e318 docs: Fix typo in facades documentation e3ac615f170f5ec pw_i2c: Doxygenify RegisterDevice 568e66fab31cc7c renode: Update renode to latest daily build 6376d6fcb42a4e3 pw_metric: Fix Bazel build https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: ed16e1d4486b6da..63903b4f24e9122 Roller-URL: https://ci.chromium.org/b/8755992865802903537 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Idcab1c0f3f472c375adf7104e2cfdabed40928ab Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/192780 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.