Skip to content

Commit a079829

Browse files
committed
vendor-ibm-astlpc.md: Fix MD036 warnings
The following warnings are generated by using markdownlint analysis: ``` docs/bindings/vendor-ibm-astlpc.md:26 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "BTU: Baseline Transmission Uni..."] docs/bindings/vendor-ibm-astlpc.md:31 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "IBF: Input Buffer Full"] docs/bindings/vendor-ibm-astlpc.md:37 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "IDR: Input Data Register"] docs/bindings/vendor-ibm-astlpc.md:42 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "KCS: Keyboard-Controller-Style"] docs/bindings/vendor-ibm-astlpc.md:52 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "LPC Bus: Low Pin Count Bus"] docs/bindings/vendor-ibm-astlpc.md:57 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "LPC FW: LPC Firmware Cycles"] docs/bindings/vendor-ibm-astlpc.md:64 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "MTU: Maximum Transmission Unit"] docs/bindings/vendor-ibm-astlpc.md:70 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "OBF: Output Buffer Full"] docs/bindings/vendor-ibm-astlpc.md:76 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "ODR: Output Data Register"] docs/bindings/vendor-ibm-astlpc.md:81 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "STR: Status Register"] ``` Refer to markdown-lint [1] to fix MD036 [1]: https://github.com/updownpress/markdown-lint/blob/master/rules/036-no-emphasis-as-header.md Signed-off-by: George Liu <liuxiwei@ieisystem.com> Change-Id: Id56964b7edff73c060215d27b55e558304b83269
1 parent d65b7d3 commit a079829

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/bindings/vendor-ibm-astlpc.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,23 @@ document.
2323

2424
## Definitions
2525

26-
**BTU: Baseline Transmission Unit**
26+
### BTU: Baseline Transmission Unit
2727

2828
Defined by the MCTP base specification as the smallest maximum packet size all
2929
MCTP-compliant endpoints must accept.
3030

31-
**IBF: Input Buffer Full**
31+
### IBF: Input Buffer Full
3232

3333
A hardware-defined flag bit in a KCS device's Status Register (STR). The IBF
3434
flag indicates that a value has been written by the host to the corresponding
3535
Input Data Register (IDR).
3636

37-
**IDR: Input Data Register**
37+
### IDR: Input Data Register
3838

3939
One of the three register interfaces exposed by a KCS device. The IDR is a one
4040
byte buffer which is written by the host and read by the BMC.
4141

42-
**KCS: Keyboard-Controller-Style**
42+
### KCS: Keyboard-Controller-Style
4343

4444
A set of bit definitions and operation of the registers typically used in
4545
keyboard microcontrollers and embedded controllers. The term "Keyboard
@@ -49,36 +49,36 @@ systems. This interface is available built-in to several commercially available
4949
microcontrollers. Data is transferred across the KCS interface using a per-byte
5050
handshake.
5151

52-
**LPC Bus: Low Pin Count Bus**
52+
### LPC Bus: Low Pin Count Bus
5353

5454
A bus specification that implements ISA bus in a reduced physical form while
5555
extending ISA's capabilities.
5656

57-
**LPC FW: LPC Firmware Cycles**
57+
### LPC FW: LPC Firmware Cycles
5858

5959
LPC firmware cycles allow separate boot BIOS firmware memory cycles and
6060
application memory cycles with respect to the LPC bus. The ASPEED BMCs allow
6161
remapping of the LPC firmware cycles onto arbitrary regions of the BMC's
6262
physical address space, including RAM.
6363

64-
**MTU: Maximum Transmission Unit**
64+
### MTU: Maximum Transmission Unit
6565

6666
The largest payload the link will accept for a packet. The Maximum Transmission
6767
Unit represents a value that is at least as large as the BTU. Negotiation of MTU
6868
values larger than the BTU may improve throughput for data-intensive transfers.
6969

70-
**OBF: Output Buffer Full**
70+
### OBF: Output Buffer Full
7171

7272
A hardware-defined flag bit in a KCS device's Status Register (STR). The OBF
7373
flag indicates that a value has been written by the BMC to the corresponding
7474
Output Data Register (ODR).
7575

76-
**ODR: Output Data Register**
76+
### ODR: Output Data Register
7777

7878
One of the three register interfaces exposed by a KCS device. The ODR is a one
7979
byte buffer which is written by the BMC and read by the host.
8080

81-
**STR: Status Register**
81+
### STR: Status Register
8282

8383
One of the three register interfaces exposed by a KCS device. STR is a
8484
BMC-controlled, eight-bit register exposed to both the BMC and the host for

0 commit comments

Comments
 (0)