docs/fingerprint: Workaround mdformat and gitiles note syntax

mdformat incorrectly formats "*** note" blocks, so disable mdformat on
those blocks.

BRANCH=none
BUG=none
TEST=View in gitiles

Signed-off-by: Tom Hughes <tomhughes@chromium.org>
Change-Id: I4a7894402373a4c91688263454d33554b324aece
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2521452
Reviewed-by: Craig Hesling <hesling@chromium.org>

4 files changed, 44 insertions, 0 deletions

diff --git a/docs/fingerprint/fingerprint-debugging.md b/docs/fingerprint/fingerprint-debugging.md
index 7316ad3434..56c72f8e3b 100644
--- a/docs/fingerprint/fingerprint-debugging.md
+++ b/docs/fingerprint/fingerprint-debugging.md
@@ -36,6 +36,7 @@ used for JTAG and SWD for ARM devices.
 
 The connector for SWD is `J4` on Dragonclaw v0.2.
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: Pay attention to the location of pin 1 (red wire) in the
 photos below so that you connect with the correct orientation.
@@ -45,6 +46,7 @@ photos below so that you connect with the correct orientation.
 If you want to connect a 20-Pin ARM Standard JTAG Connector (0.10" / 2.54 mm),
 you can use the following [adapter][JTAG to SWD Adapter] and [cable][SWD Cable].
 ***
+<!-- mdformat on -->
 
 Dragonclaw v0.2 with 20-pin SWD (0.05" / 1.27mm) on J4. Only half the pins are connected. |
 ----------------------------------------------------------------------------------------- |
diff --git a/docs/fingerprint/fingerprint-dev-for-partners.md b/docs/fingerprint/fingerprint-dev-for-partners.md
index 1aef3735fb..364cfa8c2f 100644
--- a/docs/fingerprint/fingerprint-dev-for-partners.md
+++ b/docs/fingerprint/fingerprint-dev-for-partners.md
@@ -33,6 +33,7 @@ This FPMCU board is the Dragonclaw Rev 0.2. |
 
 Download the [Dragonclaw schematics, layout, and BOM][dragonclaw schematics].
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **Googlers**: You can pick up the Dragonclaw development board at Chromestop.
 **Partners**: You can request a Dragonclaw development board from Google.
@@ -43,6 +44,7 @@ Dragonclaw Rev 0.2 needs a [rework](#dragonclaw-rev-0.2-rework) for the FPC
 sensor to work while being powered through Servo. All of the boards at Chromestop
 have already been reworked.
 ***
+<!-- mdformat on -->
 
 This FPMCU board is the Dartmonkey Rev 0.1. |
 ------------------------------------------- |
@@ -65,9 +67,11 @@ for single step debugging, but Dragonclaw v0.2 has an
 --------------------------- | ----------------------------------
 ![Servo Micro]              | ServoV2 ![Servo v2] Yoshi Flex ![Standard Yoshi Flex]
 
+<!-- mdformat off(b/139308852) -->
 *** note
 For more information about both servos, see [servo].
 ***
+<!-- mdformat on -->
 
 ### Servo Micro
 
@@ -79,9 +83,11 @@ to the developer's computer over micro USB.
 
 ![Servo Micro with Dragonclaw]
 
+<!-- mdformat off(b/139308852) -->
 *** note
 For more information about Servo Micro, see [Servo Micro Info].
 ***
+<!-- mdformat on -->
 
 #### Using SWD (Optional) {#servo-micro-swd}
 
@@ -94,9 +100,11 @@ Servo V2 is the original full featured debugger. It requires a
 
 ![Servo v2]
 
+<!-- mdformat off(b/139308852) -->
 *** note
 NOTE: More information on servo can be found in the [servo] documentation.
 ***
+<!-- mdformat on -->
 
 #### Yoshi Flex Cable
 
@@ -168,9 +176,11 @@ Open **two** terminals and enter the chroot in each:
 (outside chroot) $ cros_sdk --no-ns-pid
 ```
 
+<!-- mdformat off(b/139308852) -->
 *** note
 NOTE: More information on servo can be found in the [servo] documentation.
 ***
+<!-- mdformat on -->
 
 In one of the terminals, build and start `servod`
 
@@ -180,10 +190,12 @@ Build and install `servod` in the chroot:
 (chroot) $ sudo emerge hdctools
 ```
 
+<!-- mdformat off(b/139308852) -->
 *** note
 In all of the following commands, replace `<BOARD>` in the command with
 `bloonchipper` or `dartmonkey` depending on the development board you are using.
 ***
+<!-- mdformat on -->
 
 Run `servod`:
 
@@ -348,6 +360,7 @@ You can get a summary of the power over `N` seconds with:
 (chroot) $ dut-control -t N pp3300_dx_mcu_mv pp3300_dx_fp_mv pp1800_dx_fp_mv pp3300_dx_mcu_mw pp3300_dx_fp_mw pp1800_dx_fp_mw
 ```
 
+<!-- mdformat off(b/139308852) -->
 *** note
 The `_mv` suffix denotes millivolt and `_mw` suffix denotes milliwatt.
 ***
@@ -355,6 +368,7 @@ The `_mv` suffix denotes millivolt and `_mw` suffix denotes milliwatt.
 *** note
 See [Power Measurement Documentation] for more information.
 ***
+<!-- mdformat on -->
 
 ### Toggling Hardware Write Protect
 
@@ -413,6 +427,7 @@ register for an account on the [Internal Gerrit]. Refer to the
 account, your contact at Google can make sure you have the necessary permissions
 to access the private repository.
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: In order to use a private repository you will have to manually add it
 to the repo manifest file before running `repo sync`. Check with your contact
@@ -435,6 +450,7 @@ at Google for the exact values to use below:
         review="https://chrome-internal-review.googlesource.com" />
 ```
 ***
+<!-- mdformat on -->
 
 ### Tracking Issues and Communication
 
@@ -517,10 +533,12 @@ From the DUT, flash the firmware you copied:
 
 ### Dragonclaw Rev 0.2 Rework {#dragonclaw-rev-0.2-rework}
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: All Dragonclaw v0.2 boards have been reworked, so it is not necessary
 to perform the rework yourself.
 ***
+<!-- mdformat on -->
 
 Dragonclaw **Rev 0.2** has two load switches (`U4` and `U6`) that enable the
 1.8V power rail from the servo connector or motherboard connector. However, this
diff --git a/docs/fingerprint/fingerprint-factory-requirements.md b/docs/fingerprint/fingerprint-factory-requirements.md
index 4aaf564570..0b9659efb3 100644
--- a/docs/fingerprint/fingerprint-factory-requirements.md
+++ b/docs/fingerprint/fingerprint-factory-requirements.md
@@ -61,11 +61,13 @@ dartmonkey
 The corresponding firmware for the above command would be
 `/opt/google/biod/fw/dartmonkey_*.bin`.
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: If you get an empty response when running the above commands, the
 Chrome OS Config settings may not have been updated for the Chrome OS board.
 See the instructions on [updating Chrome OS Config] for fingerprint.
 ***
+<!-- mdformat on -->
 
 Note that the fingerprint team continuously releases updates to the firmware, so
 SIEs should watch for version changes in ToT if they are maintaining a separate
@@ -88,12 +90,14 @@ the rootfs. Note that this update process can take around 30 seconds; if that
 length of time is an issue then the factory or module house should pre-flash the
 latest firmware beforehand.
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: If the FPMCU is not flashed in the factory as part of development
 builds (EVT, etc.), it's possible for developers (or Chromestop) to manually
 run [`flash_fp_mcu`], as long as they can disable [hardware write protect].
 Obviously this only applies during development, not mass production.
 ***
+<!-- mdformat on -->
 
 ## biod and timberslide
 
@@ -187,10 +191,12 @@ Perform median analysis on the resulting image as described in the `MTS`
 document. The factory toolkit does this in
 [`fingerprint_mcu.py`][Checkerboard Test].
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **TIP**: You can view the `.pnm` files generated by the commands below on your
 Linux desktop with ImageMagick: `display /path/to/file.pnm`.
 ***
+<!-- mdformat on -->
 
 ##### Success/Failure
 
@@ -461,10 +467,12 @@ To convert the images from FPC’s proprietary format to PNG, you will need to
 have `cros deploy`’d `libfputils-nocturne`, which will install the required
 utilities in `/opt/fpc`.
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: As of 2019-05-21, the `libfputils` library only works for the FPC 1145
 sensor (in nocturne), not the FPC 1025 sensor (hatch).
 ***
+<!-- mdformat on -->
 
 Convert the buffer in proprietary format into png:
 
diff --git a/docs/fingerprint/fingerprint.md b/docs/fingerprint/fingerprint.md
index 67f7b4bf1f..8d987a45c7 100644
--- a/docs/fingerprint/fingerprint.md
+++ b/docs/fingerprint/fingerprint.md
@@ -2,16 +2,20 @@
 
 [TOC]
 
+<!-- mdformat off(b/139308852) -->
 *** note
 NOTE: The build commands assume you are in the `~/trunk/src/platform/ec`
 directory inside the chroot.
 ***
+<!-- mdformat on -->
 
+<!-- mdformat off(b/139308852) -->
 *** note
 WARNING: When switching branches in the EC codebase, you probably want to nuke
 the `build` directory or at least the board you're working on: `rm -rf
 build/<board>` or `make clobber` to prevent compilation errors.
 ***
+<!-- mdformat on -->
 
 ## Software
 
@@ -45,11 +49,13 @@ in the chroot to determine the FPMCU:
 (chroot) $  cros_config_host -c /build/<BOARD>/usr/share/chromeos-config/yaml/config.yaml -m <MODEL> get /fingerprint board
 ```
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: If you get an empty response when running these commands, the
 [Chrome OS Config] properties for fingerprint may not have been set up yet. See
 the [section on updating Chrome OS Config](#update-chromeos-config).
 ***
+<!-- mdformat on -->
 
 ## Building FPMCU Firmware Locally
 
@@ -82,10 +88,12 @@ Before uploading a change to Gerrit via `repo upload`, you'll need to build
 *all* the boards in the EC codebase to make sure your changes do not break any
 others.
 
+<!-- mdformat off(b/139308852) -->
 *** note
 NOTE: If you forget to do this, do not worry. `repo upload` will warn you and
 prevent you from uploading.
 ***
+<!-- mdformat on -->
 
 ```bash
 (chroot) ~/trunk/src/platform/ec $ make buildall -j
@@ -146,11 +154,13 @@ kernel:
 
 ### `fp_updater.sh` and `bio_fw_updater`
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: The auto-update process requires a working version of the firmware
 running on the FPMCU. See [Fingerprint Factory Requirements] for details on
 flashing in the factory.
 ***
+<!-- mdformat on -->
 
 [`fp_updater.sh`] and [`bio_fw_updater`] are wrappers around [`flashrom`] and
 require already-functioning RO firmware running on the FPMCU. It’s meant to be
@@ -168,12 +178,14 @@ user disables [hardware write protection]).
 
 ### `flash_fp_mcu`
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: This tool is really just for us to use during development or during
 the RMA flow (must go through finalization again in that case). We never update
 RO in the field (can’t by design). See [Fingerprint Factory Requirements] for
 details on flashing in the factory.
 ***
+<!-- mdformat on -->
 
 [`flash_fp_mcu`] enables spidev and toggles some GPIOs to put the FPMCU (STM32)
 into bootloader mode. At that point it uses [`stm32mon`] to rewrite the entire
@@ -318,10 +330,12 @@ fingerprint development boards.
 
 ### Dragontalon
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: The sensor doesn't work on Dragontalon, so the measurements below show
 zero for the sensor.
 ***
+<!-- mdformat on -->
 
 ```bash
 (chroot) $  dut-control -t 60 pp3300_h7_mv pp3300_h7_mw pp1800_fpc_mv pp1800_fpc_mw
@@ -392,9 +406,11 @@ See the [Hatch baseboard `make.defaults`] for an example.
 Once you have added the `FPMCU_FIRMWARE` flag and rebuilt the
 [`chromeos-firmware-fpmcu` ebuild], the firmware will show up in the the chroot:
 
+<!-- mdformat off(b/139308852) -->
 *** note
 **NOTE**: This requires access to the [internal manifest].
 ***
+<!-- mdformat on -->
 
 ```bash
 (chroot) $ emerge-<BOARD> chromeos-firmware-fpmcu