| commit | 5019bd4a59915dbecf51940c36f009e0b0cf17f9 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Jul 16 20:01:23 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Jul 16 20:01:23 2024 +0000 |
| tree | 2143e13469881d29bb386a7cf1795cd364721614 | |
| parent | fa6a0e3fc6a057cc331deddb90ab5d85f52de42b [diff] |
roll: third_party/pigweed 7 commits 60dd9633d53e69b pw_crypto: Don't build micro-ecc 9bdf7f88b60c4a2 bazel: Run under tsan, ubsan in presubmit 7de876e4cac8bb5 docs: Update pigweed.dev fonts 99f590845fe5e2b pw_cpu_exception_cortex_m: Temporarily disable tes f08c484d94d7f45 emboss: Update emboss repo to v2024.0716.040724 2eb848eb3c427a2 pw_presubmit: Add test for inclusive language chec 55dbd768bf62a1d docs: Minor updates https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: fc32542d40ea2a3..60dd9633d53e69b Roller-URL: https://ci.chromium.org/b/8742227463856583921 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I9c79c3c2cf1af76b8536ef9f74fb095031b41c27 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/223651 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.