| commit | 37f08ebe0fad5b80a6ccc7480e0aef4c4b3f5e31 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Tue Mar 19 02:56:19 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Tue Mar 19 02:56:19 2024 +0000 |
| tree | 2e631bfec0fda181ea9b5b76c77880adb354df5b | |
| parent | 8d174222f4490a8474ea362139e676fb89e34853 [diff] |
[third_party/pigweed] Roll 10 commits
2f9dd9339f474a9 pw_{assert,log}: Add keep_dep tags to backend_impl
9fce2807fecf6d1 python: Switch from typing.Optional[...] to "... |
a7ae303c326f03b python: Switch from typing.Union to "|"
cccf6991fb2ac81 python: Use argparse.BooleanOptionalAction
29145e1bad586aa python: Use pathlib.Path.is_relative_to()
5ae66deb4c7d159 python: Switch from typing.Dict to dict
29485980c72340b docs: Add redirects infrastructure and docs contri
139448a532041f5 python: Switch from typing.Tuple to tuple
fd2ad3a688da8f0 python: Switch from typing.List to list
a9f055a32cc1ac0 pw_package: Match Emboss version used by Bazel
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed Rolled-Commits: fa8e6c497fa2268..2f9dd9339f474a9
Roller-URL: https://ci.chromium.org/b/8753074279446778049
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I365cbaedf63f1eb01faab4b3087fcc9373c3f3ff
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/197473
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.