Commit Graph

12 Commits

Author SHA1 Message Date
Wyatt Hepler
f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00
Keir Mierle
22dd0b0b48 stm32f429: Document debugging w/ GDB
Change-Id: I8faf7bf3928f0da60d96fb9ad0edb952b749a230
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/13880
Commit-Queue: Keir Mierle <keir@google.com>
Reviewed-by: Armando Montanez <amontanez@google.com>
2020-08-14 19:33:11 +00:00
Ewout van Bekkum
e072fabcf0 docs: some more minor updates
Fixes some errors and some stale references and formats.

Change-Id: I5a2f6d4a20591b61ae49eaab3310dc7abf51d83d
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/14122
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Ewout van Bekkum <ewout@google.com>
2020-07-18 02:38:39 +00:00
Armando Montanez
856860ec39 stm32f429i-disc1: Fix out directory path
Changes references to `out/disco` to just be `out` to match the new
world.

Change-Id: If54f889c179db77ac4304fbcd5cf072a6f0eb331
2020-06-18 10:11:47 -07:00
Armando Montanez
a761e32bf9 Update docs
First pass at docs to bring them up to date with The Great GN Refactor.
More to follow.

Change-Id: I02dc977fcdc7bf3efa8fc9080282dee9b1455cdd
2020-06-16 10:00:17 -07:00
Armando Montanez
bcc194b750 docs: Extend readme, more docs
Adds/updates docs.

Bug: 125, 129

Change-Id: I96b8bc07c3817d6b629e546f74c06d7345b3227e
2020-03-12 18:00:44 +00:00
Rob Mohr
2cc32ecdfb Move env_setup to pw_env_setup
Bug: 67
Change-Id: I285e917968b2e24e0851753ea4802cef1fbe2d67
2020-02-05 19:07:01 +00:00
Alexei Frolov
44d5473453 Various small docs fixes
This fixes some typos in the docs.

Change-Id: I4dc2e3b8fa7685bc994123929513a58e8d0e9c79
2020-01-11 01:03:51 +00:00
Armando Montanez
c0ad978eac pw_target_runner: Update name change in docs
Updates pw_target_runner (and other) docs to reflect the name change
from pw_test_server to pw_target_runner.

Change-Id: Iffa81088b81a1b83c285949c73fbf93e23f478a3
2020-01-07 18:08:33 +00:00
Armando Montanez
975449b025 stm32f429i-disc1: Update docs
Update docs to reflect improvements to device detection and
pw_target_runner.

Change-Id: Iac29e2efcf976977e6b9bbbf710dcdacd4eae266
2020-01-06 18:19:14 +00:00
Armando Montanez
8c235cec60
stm32f429i-disc1: Add unit test server
Adds a build argument to the stm32f429i-disc1 target that enables
running tests via the pw_test_server.

Change-Id: I76c98fa25d27c771251e41de8631f156572f7731
2019-12-13 11:33:17 -08:00
Armando Montanez
0874558cf3 docs: Add 'targets' section
Creates a new section in the docs for target documentation, and adds
some documentation for the stm32f429i-disc1 target.

Change-Id: I0ffbfa56a97458d850834fc0f670b32885b0d2b5
2019-12-12 21:15:16 +00:00