[third_party/pigweed] Roll 2 commits

517696e29810c51 docs: Mention that Windows flow needs admin rights
849d99bd97a5613 pw_presubmit: Include examples repo docs in docs_b

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed Rolled-Commits: 3f89c18fdffd43f..517696e29810c51
Roller-URL: https://ci.chromium.org/b/8751540656879868001
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: If06cb848f2617d125fce0fcc48aea611aa21a7c2
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/201977
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 10e794c38d8074e45ec0e3fcbcebd37d6a8aa2c5
  1. src/
  2. targets/
  3. third_party/
  4. tools/
  5. .bazelrc
  6. .bazelversion
  7. .gitignore
  8. .gitmodules
  9. BUILD.bazel
  10. echo.bzl
  11. README.md
  12. requirements.in
  13. requirements_lock.txt
  14. WORKSPACE
README.md

Pigweed: minimal Bazel example

This repository contains a minimal example of a Bazel-based Pigweed project. It's an echo application for the STM32F429 Discovery Board.

Cloning

git clone --recursive https://pigweed.googlesource.com/pigweed/quickstart/bazel

If you already cloned but forgot to include --recursive, run git submodule update --init to pull all submodules.

TODO: b/300695111 - Don't require submodules for this example.

Building

We‘ll assume you already have Bazel on your system. If you don’t, the recommended way to get it is through Bazelisk.

To build the entire project (including building the application for both the host and the STM32 Discovery Board), run

bazel build //...

To run the application locally on your machine, run,

bazel run //src:echo

Flashing

To flash the firmware to a STM32F429 Discovery Board connected to your machine, run,

bazel run //tools:flash

Note that you don't need to build the firmware first: Bazel knows that the firmware images are needed to flash the board, and will build them for you. And if you edit the source of the firmware or any of its dependencies, it will get rebuilt when you flash.

Communicating

Run,

bazel run //tools:miniterm -- /dev/ttyACM0 --filter=debug

to communicate with the board. When you transmit a character, you should get the same character back!