commit | d6e3db2f746e3355f46d0194dc3f481ce889dc84 | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Apr 16 17:56:35 2024 +0000 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Apr 16 17:56:35 2024 +0000 |
tree | 89521e42a54ccc6c2521a49c764ce907525259c4 | |
parent | b3d1a2006b53dc79c220e99c9428ddfb1984e598 [diff] |
[third_party/pigweed] Roll 14 commits ffd7f02f75eec34 pw_cli: Fix commit fallback handling for GitRepo.l 6913460a9bd1bd6 pw_ide: Enable cmake.format.allowOptionalArgumentI 1154ff5dda14d5d pw_build_android: Update cc_defaults guidance b5b08af769c2a3a pw_rpc_transport: Soong lib names now follow style b657245b27e28db pw_web: NPM version bump to 0.0.18 53e8f63714ca67b pw_web: Fix string manipulation in download logs 4152b6754ca7a74 pw_allocator: Add missing soong deps e3c8e94cbffee47 pw_transfer: Implement adaptive windowing in Pytho 79c1f24e16c01c3 pw_web: Use existing col data when adding new View 3fbcf41574028ef docs: Revamp Doxygen style guide 19d58a7afb51ced pw_transfer: Implement adaptive windowing in C++ 28826a8a3014f44 pw_{cli,presubmit}: Move git_repo to pw_cli acc3de9c3173a4a pw_cli: Add Python deprecation decorator 003d721ee784560 pw_blob_store: Fix CMakeLists.txt pw_add_library() https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed Rolled-Commits: 57d41af75d9459d..ffd7f02f75eec34 Roller-URL: https://ci.chromium.org/b/8750479424517266881 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I6d0f4ca12ee07061e461a6d5bec806220c1c34a8 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/203890 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
.