Skip to content

Commit a667e4d

Browse files
Yanteng Sichenhuacai
authored andcommitted
docs/LoongArch: Fix notes rendering by using reST directives
Notes are better expressed with reST admonitions. Fixes: 0ea8ce6 ("Documentation: LoongArch: Add basic documentations") Reviewed-by: WANG Xuerui <[email protected]> Signed-off-by: Yanteng Si <[email protected]> Signed-off-by: Huacai Chen <[email protected]>
1 parent b672332 commit a667e4d

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

Documentation/loongarch/introduction.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,12 @@ Name Alias Usage Preserved
4545
``$r23``-``$r31`` ``$s0``-``$s8`` Static registers Yes
4646
================= =============== =================== ============
4747

48-
Note: The register ``$r21`` is reserved in the ELF psABI, but used by the Linux
49-
kernel for storing the percpu base address. It normally has no ABI name, but is
50-
called ``$u0`` in the kernel. You may also see ``$v0`` or ``$v1`` in some old code,
51-
however they are deprecated aliases of ``$a0`` and ``$a1`` respectively.
48+
.. Note::
49+
The register ``$r21`` is reserved in the ELF psABI, but used by the Linux
50+
kernel for storing the percpu base address. It normally has no ABI name,
51+
but is called ``$u0`` in the kernel. You may also see ``$v0`` or ``$v1``
52+
in some old code,however they are deprecated aliases of ``$a0`` and ``$a1``
53+
respectively.
5254

5355
FPRs
5456
----
@@ -69,8 +71,9 @@ Name Alias Usage Preserved
6971
``$f24``-``$f31`` ``$fs0``-``$fs7`` Static registers Yes
7072
================= ================== =================== ============
7173

72-
Note: You may see ``$fv0`` or ``$fv1`` in some old code, however they are deprecated
73-
aliases of ``$fa0`` and ``$fa1`` respectively.
74+
.. Note::
75+
You may see ``$fv0`` or ``$fv1`` in some old code, however they are
76+
deprecated aliases of ``$fa0`` and ``$fa1`` respectively.
7477

7578
VRs
7679
----

Documentation/loongarch/irq-chip-model.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -145,12 +145,16 @@ Documentation of Loongson's LS7A chipset:
145145

146146
https://github.com/loongson/LoongArch-Documentation/releases/latest/download/Loongson-7A1000-usermanual-2.00-EN.pdf (in English)
147147

148-
Note: CPUINTC is CSR.ECFG/CSR.ESTAT and its interrupt controller described
149-
in Section 7.4 of "LoongArch Reference Manual, Vol 1"; LIOINTC is "Legacy I/O
150-
Interrupts" described in Section 11.1 of "Loongson 3A5000 Processor Reference
151-
Manual"; EIOINTC is "Extended I/O Interrupts" described in Section 11.2 of
152-
"Loongson 3A5000 Processor Reference Manual"; HTVECINTC is "HyperTransport
153-
Interrupts" described in Section 14.3 of "Loongson 3A5000 Processor Reference
154-
Manual"; PCH-PIC/PCH-MSI is "Interrupt Controller" described in Section 5 of
155-
"Loongson 7A1000 Bridge User Manual"; PCH-LPC is "LPC Interrupts" described in
156-
Section 24.3 of "Loongson 7A1000 Bridge User Manual".
148+
.. Note::
149+
- CPUINTC is CSR.ECFG/CSR.ESTAT and its interrupt controller described
150+
in Section 7.4 of "LoongArch Reference Manual, Vol 1";
151+
- LIOINTC is "Legacy I/OInterrupts" described in Section 11.1 of
152+
"Loongson 3A5000 Processor Reference Manual";
153+
- EIOINTC is "Extended I/O Interrupts" described in Section 11.2 of
154+
"Loongson 3A5000 Processor Reference Manual";
155+
- HTVECINTC is "HyperTransport Interrupts" described in Section 14.3 of
156+
"Loongson 3A5000 Processor Reference Manual";
157+
- PCH-PIC/PCH-MSI is "Interrupt Controller" described in Section 5 of
158+
"Loongson 7A1000 Bridge User Manual";
159+
- PCH-LPC is "LPC Interrupts" described in Section 24.3 of
160+
"Loongson 7A1000 Bridge User Manual".

0 commit comments

Comments
 (0)