[PATCH 0/2] docs/loongarch: improve loongarch documents

[PATCH 0/2] docs/loongarch: improve loongarch documents

[Yanteng Si]

Rewrite all the notes in the loongarch document.

Note is an admonition, let's use the directives
implemented in the reference reStructuredText parser.
About reStructuredText Directives,
see <https://docutils.sourceforge.io/docs/ref/rst/directives.html>

Yanteng Si (2):
  docs/loongarch: rewrite all the notes
  docs/zh_CN: rewrite all the notes

 Documentation/loongarch/introduction.rst      | 15 ++++++++-----
 Documentation/loongarch/irq-chip-model.rst    | 22 +++++++++++--------
 .../zh_CN/loongarch/introduction.rst          | 14 +++++++-----
 .../zh_CN/loongarch/irq-chip-model.rst        | 15 ++++++++-----
 4 files changed, 39 insertions(+), 27 deletions(-)

-- 
2.27.0

[PATCH 1/2] docs/loongarch: rewrite all the notes

[Yanteng Si]

Note is an admonition, let's use the directives
implemented in the reference reStructuredText parser.

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
---
 Documentation/loongarch/introduction.rst   | 15 +++++++++------
 Documentation/loongarch/irq-chip-model.rst | 22 +++++++++++++---------
 2 files changed, 22 insertions(+), 15 deletions(-)

diff --git a/Documentation/loongarch/introduction.rst b/Documentation/loongarch/introduction.rst
index 2bf40ad370df..46e3f8d54067 100644
--- a/Documentation/loongarch/introduction.rst
+++ b/Documentation/loongarch/introduction.rst
@@ -45,10 +45,12 @@ Name              Alias           Usage               Preserved
 ``$r23``-``$r31`` ``$s0``-``$s8`` Static registers    Yes
 ================= =============== =================== ============
 
-Note: The register ``$r21`` is reserved in the ELF psABI, but used by the Linux
-kernel for storing the percpu base address. It normally has no ABI name, but is
-called ``$u0`` in the kernel. You may also see ``$v0`` or ``$v1`` in some old code,
-however they are deprecated aliases of ``$a0`` and ``$a1`` respectively.
+.. Note:
+    The register ``$r21`` is reserved in the ELF psABI, but used by the Linux
+    kernel for storing the percpu base address. It normally has no ABI name,
+    but is called ``$u0`` in the kernel. You may also see ``$v0`` or ``$v1``
+    in some old code,however they are deprecated aliases of ``$a0`` and ``$a1``
+    respectively.
 
 FPRs
 ----
@@ -69,8 +71,9 @@ Name              Alias              Usage               Preserved
 ``$f24``-``$f31`` ``$fs0``-``$fs7``  Static registers    Yes
 ================= ================== =================== ============
 
-Note: You may see ``$fv0`` or ``$fv1`` in some old code, however they are deprecated
-aliases of ``$fa0`` and ``$fa1`` respectively.
+.. Note::
+    You may see ``$fv0`` or ``$fv1`` in some old code, however they are
+    deprecated aliases of ``$fa0`` and ``$fa1`` respectively.
 
 VRs
 ----
diff --git a/Documentation/loongarch/irq-chip-model.rst b/Documentation/loongarch/irq-chip-model.rst
index 8d88f7ab2e5e..7988f4192363 100644
--- a/Documentation/loongarch/irq-chip-model.rst
+++ b/Documentation/loongarch/irq-chip-model.rst
@@ -145,12 +145,16 @@ Documentation of Loongson's LS7A chipset:
 
   https://github.com/loongson/LoongArch-Documentation/releases/latest/download/Loongson-7A1000-usermanual-2.00-EN.pdf (in English)
 
-Note: CPUINTC is CSR.ECFG/CSR.ESTAT and its interrupt controller described
-in Section 7.4 of "LoongArch Reference Manual, Vol 1"; LIOINTC is "Legacy I/O
-Interrupts" described in Section 11.1 of "Loongson 3A5000 Processor Reference
-Manual"; EIOINTC is "Extended I/O Interrupts" described in Section 11.2 of
-"Loongson 3A5000 Processor Reference Manual"; HTVECINTC is "HyperTransport
-Interrupts" described in Section 14.3 of "Loongson 3A5000 Processor Reference
-Manual"; PCH-PIC/PCH-MSI is "Interrupt Controller" described in Section 5 of
-"Loongson 7A1000 Bridge User Manual"; PCH-LPC is "LPC Interrupts" described in
-Section 24.3 of "Loongson 7A1000 Bridge User Manual".
+.. Note::
+    - CPUINTC is CSR.ECFG/CSR.ESTAT and its interrupt controller described
+      in Section 7.4 of "LoongArch Reference Manual, Vol 1";
+    - LIOINTC is "Legacy I/OInterrupts" described in Section 11.1 of
+      "Loongson 3A5000 Processor Reference Manual";
+    - EIOINTC is "Extended I/O Interrupts" described in Section 11.2 of
+      "Loongson 3A5000 Processor Reference Manual";
+    - HTVECINTC is "HyperTransport Interrupts" described in Section 14.3 of
+      "Loongson 3A5000 Processor Reference Manual";
+    - PCH-PIC/PCH-MSI is "Interrupt Controller" described in Section 5 of
+      "Loongson 7A1000 Bridge User Manual";
+    - PCH-LPC is "LPC Interrupts" described in Section 24.3 of
+      "Loongson 7A1000 Bridge User Manual".
-- 
2.27.0

[PATCH 2/2] docs/zh_CN: rewrite all the notes

[Yanteng Si]

Note is an admonition, let's use the directives
implemented in the reference reStructuredText parser.

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
---
 .../translations/zh_CN/loongarch/introduction.rst | 14 ++++++++------
 .../zh_CN/loongarch/irq-chip-model.rst            | 15 +++++++++------
 2 files changed, 17 insertions(+), 12 deletions(-)

diff --git a/Documentation/translations/zh_CN/loongarch/introduction.rst b/Documentation/translations/zh_CN/loongarch/introduction.rst
index e31a1a928c48..a8a5aaca7d94 100644
--- a/Documentation/translations/zh_CN/loongarch/introduction.rst
+++ b/Documentation/translations/zh_CN/loongarch/introduction.rst
@@ -46,10 +46,11 @@ LA64中每个寄存器为64位宽。 ``$r0`` 的内容总是固定为0，而其
 ``$r23``-``$r31`` ``$s0``-``$s8`` 静态寄存器          是
 ================= =============== =================== ==========
 
-注意：``$r21``寄存器在ELF psABI中保留未使用，但是在Linux内核用于保存每CPU
-变量基地址。该寄存器没有ABI命名，不过在内核中称为``$u0``。在一些遗留代码
-中有时可能见到``$v0``和``$v1``，它们是``$a0``和``$a1``的别名，属于已经废弃
-的用法。
+.. note::
+    注意： ``$r21``寄存器在ELF psABI中保留未使用，但是在Linux内核用于保
+    存每CPU变量基地址。该寄存器没有ABI命名，不过在内核中称为``$u0``。在一
+    些遗留代码中有时可能见到``$v0``和``$v1``，它们是``$a0``和``$a1``的
+    别名，属于已经废弃的用法。
 
 浮点寄存器
 ----------
@@ -68,8 +69,9 @@ LA64中每个寄存器为64位宽。 ``$r0`` 的内容总是固定为0，而其
 ``$f24``-``$f31`` ``$fs0``-``$fs7``  静态寄存器          是
 ================= ================== =================== ==========
 
-注意：在一些遗留代码中有时可能见到 ``$v0`` 和 ``$v1`` ，它们是 ``$a0``
-和 ``$a1`` 的别名，属于已经废弃的用法。
+.. note::
+    注意：在一些遗留代码中有时可能见到 ``$v0`` 和 ``$v1`` ，它们是
+    ``$a0``和 ``$a1`` 的别名，属于已经废弃的用法。
 
 
 向量寄存器
diff --git a/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst b/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
index 2a4c3ad38be4..49b7bdb59a4a 100644
--- a/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
+++ b/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
@@ -147,9 +147,12 @@ PCH-LPC::
 
   https://github.com/loongson/LoongArch-Documentation/releases/latest/download/Loongson-7A1000-usermanual-2.00-EN.pdf (英文版)
 
-注：CPUINTC即《龙芯架构参考手册卷一》第7.4节所描述的CSR.ECFG/CSR.ESTAT寄存器及其中断
-控制逻辑；LIOINTC即《龙芯3A5000处理器使用手册》第11.1节所描述的“传统I/O中断”；EIOINTC
-即《龙芯3A5000处理器使用手册》第11.2节所描述的“扩展I/O中断”；HTVECINTC即《龙芯3A5000
-处理器使用手册》第14.3节所描述的“HyperTransport中断”；PCH-PIC/PCH-MSI即《龙芯7A1000桥
-片用户手册》第5章所描述的“中断控制器”；PCH-LPC即《龙芯7A1000桥片用户手册》第24.3节所
-描述的“LPC中断”。
+.. note::
+   注：
+    - CPUINTC：即《龙芯架构参考手册卷一》第7.4节所描述的CSR.ECFG/CSR.ESTAT寄存器及其
+      中断控制逻辑；
+    - LIOINTC：即《龙芯3A5000处理器使用手册》第11.1节所描述的“传统I/O中断”；
+    - EIOINTC：即《龙芯3A5000处理器使用手册》第11.2节所描述的“扩展I/O中断”；
+    - HTVECINTC：即《龙芯3A5000处理器使用手册》第14.3节所描述的“HyperTransport中断”；
+    - PCH-PIC/PCH-MSI：即《龙芯7A1000桥片用户手册》第5章所描述的“中断控制器”；
+    - PCH-LPC：即《龙芯7A1000桥片用户手册》第24.3节所描述的“LPC中断”。
-- 
2.27.0

Re: [PATCH 2/2] docs/zh_CN: rewrite all the notes

[Huacai Chen]

Hi, Yanteng,

On Fri, Jun 17, 2022 at 3:17 PM Yanteng Si <siyanteng@loongson.cn> wrote:
>
> Note is an admonition, let's use the directives
> implemented in the reference reStructuredText parser.
>
> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
> ---
>  .../translations/zh_CN/loongarch/introduction.rst | 14 ++++++++------
>  .../zh_CN/loongarch/irq-chip-model.rst            | 15 +++++++++------
>  2 files changed, 17 insertions(+), 12 deletions(-)
>
> diff --git a/Documentation/translations/zh_CN/loongarch/introduction.rst b/Documentation/translations/zh_CN/loongarch/introduction.rst
> index e31a1a928c48..a8a5aaca7d94 100644
> --- a/Documentation/translations/zh_CN/loongarch/introduction.rst
> +++ b/Documentation/translations/zh_CN/loongarch/introduction.rst
> @@ -46,10 +46,11 @@ LA64中每个寄存器为64位宽。 ``$r0`` 的内容总是固定为0，而其
>  ``$r23``-``$r31`` ``$s0``-``$s8`` 静态寄存器          是
>  ================= =============== =================== ==========
>
> -注意：``$r21``寄存器在ELF psABI中保留未使用，但是在Linux内核用于保存每CPU
> -变量基地址。该寄存器没有ABI命名，不过在内核中称为``$u0``。在一些遗留代码
> -中有时可能见到``$v0``和``$v1``，它们是``$a0``和``$a1``的别名，属于已经废弃
> -的用法。
> +.. note::
> +    注意： ``$r21``寄存器在ELF psABI中保留未使用，但是在Linux内核用于保
> +    存每CPU变量基地址。该寄存器没有ABI命名，不过在内核中称为``$u0``。在一
> +    些遗留代码中有时可能见到``$v0``和``$v1``，它们是``$a0``和``$a1``的
> +    别名，属于已经废弃的用法。
There should be a space between ``$r21`` and Chinese text for HTML
display, please fix all of such problems, thanks.

Huacai
>
>  浮点寄存器
>  ----------
> @@ -68,8 +69,9 @@ LA64中每个寄存器为64位宽。 ``$r0`` 的内容总是固定为0，而其
>  ``$f24``-``$f31`` ``$fs0``-``$fs7``  静态寄存器          是
>  ================= ================== =================== ==========
>
> -注意：在一些遗留代码中有时可能见到 ``$v0`` 和 ``$v1`` ，它们是 ``$a0``
> -和 ``$a1`` 的别名，属于已经废弃的用法。
> +.. note::
> +    注意：在一些遗留代码中有时可能见到 ``$v0`` 和 ``$v1`` ，它们是
> +    ``$a0``和 ``$a1`` 的别名，属于已经废弃的用法。
>
>
>  向量寄存器
> diff --git a/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst b/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
> index 2a4c3ad38be4..49b7bdb59a4a 100644
> --- a/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
> +++ b/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
> @@ -147,9 +147,12 @@ PCH-LPC::
>
>    https://github.com/loongson/LoongArch-Documentation/releases/latest/download/Loongson-7A1000-usermanual-2.00-EN.pdf (英文版)
>
> -注：CPUINTC即《龙芯架构参考手册卷一》第7.4节所描述的CSR.ECFG/CSR.ESTAT寄存器及其中断
> -控制逻辑；LIOINTC即《龙芯3A5000处理器使用手册》第11.1节所描述的“传统I/O中断”；EIOINTC
> -即《龙芯3A5000处理器使用手册》第11.2节所描述的“扩展I/O中断”；HTVECINTC即《龙芯3A5000
> -处理器使用手册》第14.3节所描述的“HyperTransport中断”；PCH-PIC/PCH-MSI即《龙芯7A1000桥
> -片用户手册》第5章所描述的“中断控制器”；PCH-LPC即《龙芯7A1000桥片用户手册》第24.3节所
> -描述的“LPC中断”。
> +.. note::
> +   注：
> +    - CPUINTC：即《龙芯架构参考手册卷一》第7.4节所描述的CSR.ECFG/CSR.ESTAT寄存器及其
> +      中断控制逻辑；
> +    - LIOINTC：即《龙芯3A5000处理器使用手册》第11.1节所描述的“传统I/O中断”；
> +    - EIOINTC：即《龙芯3A5000处理器使用手册》第11.2节所描述的“扩展I/O中断”；
> +    - HTVECINTC：即《龙芯3A5000处理器使用手册》第14.3节所描述的“HyperTransport中断”；
> +    - PCH-PIC/PCH-MSI：即《龙芯7A1000桥片用户手册》第5章所描述的“中断控制器”；
> +    - PCH-LPC：即《龙芯7A1000桥片用户手册》第24.3节所描述的“LPC中断”。
> --
> 2.27.0
>

Re: [PATCH 2/2] docs/zh_CN: rewrite all the notes

[YanTeng Si]

在 2022/6/17 16:06, Huacai Chen 写道:
> Hi, Yanteng,
>
> On Fri, Jun 17, 2022 at 3:17 PM Yanteng Si <siyanteng@loongson.cn> wrote:
>> Note is an admonition, let's use the directives
>> implemented in the reference reStructuredText parser.
>>
>> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
>> ---
>>   .../translations/zh_CN/loongarch/introduction.rst | 14 ++++++++------
>>   .../zh_CN/loongarch/irq-chip-model.rst            | 15 +++++++++------
>>   2 files changed, 17 insertions(+), 12 deletions(-)
>>
>> diff --git a/Documentation/translations/zh_CN/loongarch/introduction.rst b/Documentation/translations/zh_CN/loongarch/introduction.rst
>> index e31a1a928c48..a8a5aaca7d94 100644
>> --- a/Documentation/translations/zh_CN/loongarch/introduction.rst
>> +++ b/Documentation/translations/zh_CN/loongarch/introduction.rst
>> @@ -46,10 +46,11 @@ LA64中每个寄存器为64位宽。 ``$r0`` 的内容总是固定为0，而其
>>   ``$r23``-``$r31`` ``$s0``-``$s8`` 静态寄存器          是
>>   ================= =============== =================== ==========
>>
>> -注意：``$r21``寄存器在ELF psABI中保留未使用，但是在Linux内核用于保存每CPU
>> -变量基地址。该寄存器没有ABI命名，不过在内核中称为``$u0``。在一些遗留代码
>> -中有时可能见到``$v0``和``$v1``，它们是``$a0``和``$a1``的别名，属于已经废弃
>> -的用法。
>> +.. note::
>> +    注意： ``$r21``寄存器在ELF psABI中保留未使用，但是在Linux内核用于保
>> +    存每CPU变量基地址。该寄存器没有ABI命名，不过在内核中称为``$u0``。在一
>> +    些遗留代码中有时可能见到``$v0``和``$v1``，它们是``$a0``和``$a1``的
>> +    别名，属于已经废弃的用法。
> There should be a space between ``$r21`` and Chinese text for HTML
> display, please fix all of such problems, thanks.

OK!


Thanks,

Yanteng

>
> Huacai
>>   浮点寄存器
>>   ----------
>> @@ -68,8 +69,9 @@ LA64中每个寄存器为64位宽。 ``$r0`` 的内容总是固定为0，而其
>>   ``$f24``-``$f31`` ``$fs0``-``$fs7``  静态寄存器          是
>>   ================= ================== =================== ==========
>>
>> -注意：在一些遗留代码中有时可能见到 ``$v0`` 和 ``$v1`` ，它们是 ``$a0``
>> -和 ``$a1`` 的别名，属于已经废弃的用法。
>> +.. note::
>> +    注意：在一些遗留代码中有时可能见到 ``$v0`` 和 ``$v1`` ，它们是
>> +    ``$a0``和 ``$a1`` 的别名，属于已经废弃的用法。
>>
>>
>>   向量寄存器
>> diff --git a/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst b/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
>> index 2a4c3ad38be4..49b7bdb59a4a 100644
>> --- a/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
>> +++ b/Documentation/translations/zh_CN/loongarch/irq-chip-model.rst
>> @@ -147,9 +147,12 @@ PCH-LPC::
>>
>>     https://github.com/loongson/LoongArch-Documentation/releases/latest/download/Loongson-7A1000-usermanual-2.00-EN.pdf (英文版)
>>
>> -注：CPUINTC即《龙芯架构参考手册卷一》第7.4节所描述的CSR.ECFG/CSR.ESTAT寄存器及其中断
>> -控制逻辑；LIOINTC即《龙芯3A5000处理器使用手册》第11.1节所描述的“传统I/O中断”；EIOINTC
>> -即《龙芯3A5000处理器使用手册》第11.2节所描述的“扩展I/O中断”；HTVECINTC即《龙芯3A5000
>> -处理器使用手册》第14.3节所描述的“HyperTransport中断”；PCH-PIC/PCH-MSI即《龙芯7A1000桥
>> -片用户手册》第5章所描述的“中断控制器”；PCH-LPC即《龙芯7A1000桥片用户手册》第24.3节所
>> -描述的“LPC中断”。
>> +.. note::
>> +   注：
>> +    - CPUINTC：即《龙芯架构参考手册卷一》第7.4节所描述的CSR.ECFG/CSR.ESTAT寄存器及其
>> +      中断控制逻辑；
>> +    - LIOINTC：即《龙芯3A5000处理器使用手册》第11.1节所描述的“传统I/O中断”；
>> +    - EIOINTC：即《龙芯3A5000处理器使用手册》第11.2节所描述的“扩展I/O中断”；
>> +    - HTVECINTC：即《龙芯3A5000处理器使用手册》第14.3节所描述的“HyperTransport中断”；
>> +    - PCH-PIC/PCH-MSI：即《龙芯7A1000桥片用户手册》第5章所描述的“中断控制器”；
>> +    - PCH-LPC：即《龙芯7A1000桥片用户手册》第24.3节所描述的“LPC中断”。
>> --
>> 2.27.0
>>