| commit | 5fe50dc4d0c4173120e77d35434e89122467198b | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Apr 21 18:33:09 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Apr 21 18:33:09 2025 -0700 |
| tree | c8b79119fbc2ab6414755167418d39efee38659e | |
| parent | 52eee6fc5cb396141f1c41ae5da3d471401ffcf0 [diff] |
roll: third_party/pigweed 996bf64..5044006 (8 commits) 5044006:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285257 pw_base64: Use div_ceil for encoded size calculation 72f264b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285357 pw_work_queue: Add missing mutex include e587b7e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285293 third_party/embos: Use pw_external_embos in gn e658fd4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285259 pw_toolchain: Use rust nightly channel to compile stdlib 59db474:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285332 third_party/freertos: Use pw_external_freertos in gn a5fd1e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284877 pw_metric: Migrate size reports to Bazel c946806:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284879 pw_kvs: Migrate size reports to Bazel cc29764:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285294 third_party/emboss: Use pw_external_emboss in gn Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 996bf642217a8c..50440062822a07 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8716929882066593841 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ie2cb3fcf97d94bbf3ff47cd0a934b4109c0469e4 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/285266 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> 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.