| commit | 52a0c4fb17095ed447b8680989a6653c6f1d0e20 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Jul 16 22:57:29 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Jul 16 22:57:29 2024 +0000 |
| tree | 259022ef294be6ce4c5d4e7bb660d4efb0600150 | |
| parent | 5019bd4a59915dbecf51940c36f009e0b0cf17f9 [diff] |
roll: third_party/pigweed 8 commits b668ec403097832 pw_presubmit: No copyright check in .vscodeignore 031dba7cd2b4eae emboss: Remove -Wno-format-invalid-specifier 07a9afe8a840ef9 pw_ide: Don't show root comp DB dir as target 0c7db655fb64de7 pw_result: Fix docs.rst example b188ee240266da8 pw_console: Cleanup web kernel on page close 3d2173aa0ad7ae1 pw_presubmit: Skip commit message check for merges 2772d9b730f5a5d bazel: Create separate "sanitizers" CI program 16d93199ea412dc pw_toolchain: Host clang toolchain for Bazel https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 60dd9633d53e69b..b668ec403097832 Roller-URL: https://ci.chromium.org/b/8742216157563579073 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Id9d9a815865bf8cfcf6a4c51f6a6b8f3b7a60dd9 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/223537 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: 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.