docs/misc/arm: Update references to Linux kernel docs

[PATCH] docs/misc/arm: Update references to Linux kernel docs

Posted by Michal Orzel 1 year, 5 months ago

Some time ago, Linux switched the format of docs to ReST and the format
of device-tree bindings to json-schema.

Signed-off-by: Michal Orzel <michal.orzel@amd.com>
---
 docs/misc/arm/booting.txt     | 8 ++++----
 docs/misc/arm/passthrough.txt | 8 ++++----
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/misc/arm/booting.txt b/docs/misc/arm/booting.txt
index d3f6ce4755f6..3e0c03e06596 100644
--- a/docs/misc/arm/booting.txt
+++ b/docs/misc/arm/booting.txt
@@ -34,8 +34,8 @@ Xen relies on some settings the firmware has to configure in EL3 before starting
 * The bit SCR_EL3.HCE (resp. SCR.HCE for 32-bit ARM) must be set to 1.
 
 
-[1] linux/Documentation/arm/Booting
-Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm/Booting
+[1] linux/Documentation/arm/booting.rst
+Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm/booting.rst
 
-[2] linux/Documentation/arm64/booting.txt
-Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm64/booting.txt
+[2] linux/Documentation/arm64/booting.rst
+Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm64/booting.rst
diff --git a/docs/misc/arm/passthrough.txt b/docs/misc/arm/passthrough.txt
index 219d1cca571b..4f0a024818a2 100644
--- a/docs/misc/arm/passthrough.txt
+++ b/docs/misc/arm/passthrough.txt
@@ -71,8 +71,8 @@ Please refer to your platform docs for the MMIO ranges and interrupts.
 They can also be calculated from the original device tree (not
 recommended). You can read about the "interrupts" property format in the
 device tree bindings of the interrupt controller of your platform. For
-example, in the case of GICv2 see [arm,gic.txt]; in the case of GICv3
-see [arm,gic-v3.txt] in the Linux repository. For both GICv2 and GICv3
+example, in the case of GICv2 see [arm,gic.yaml]; in the case of GICv3
+see [arm,gic-v3.yaml] in the Linux repository. For both GICv2 and GICv3
 the "interrupts" property format is the same: the first cell is the
 interrupt type, and the second cell is the interrupt number.  Given that
 SPI numbers start from 32, in this example 80 + 32 = 112.
@@ -187,6 +187,6 @@ assign a network card to a dom0-less guest on Xilinx Ultrascale+ MPSoC:
 };
 
 
-[arm,gic.txt]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic.txt
-[arm,gic-v3.txt]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic-v3.txt
+[arm,gic.yaml]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic.yaml
+[arm,gic-v3.yaml]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic-v3.yaml
 [xl.cfg]: https://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html
-- 
2.25.1

Re: [PATCH] docs/misc/arm: Update references to Linux kernel docs

Posted by Bertrand Marquis 1 year, 5 months ago

Hi Michal,

> On 18 Nov 2022, at 11:45, Michal Orzel <michal.orzel@amd.com> wrote:
> 
> Some time ago, Linux switched the format of docs to ReST and the format
> of device-tree bindings to json-schema.
> 
> Signed-off-by: Michal Orzel <michal.orzel@amd.com>
Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com>

Cheers
Bertrand

> ---
> docs/misc/arm/booting.txt     | 8 ++++----
> docs/misc/arm/passthrough.txt | 8 ++++----
> 2 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/docs/misc/arm/booting.txt b/docs/misc/arm/booting.txt
> index d3f6ce4755f6..3e0c03e06596 100644
> --- a/docs/misc/arm/booting.txt
> +++ b/docs/misc/arm/booting.txt
> @@ -34,8 +34,8 @@ Xen relies on some settings the firmware has to configure in EL3 before starting
> * The bit SCR_EL3.HCE (resp. SCR.HCE for 32-bit ARM) must be set to 1.
> 
> 
> -[1] linux/Documentation/arm/Booting
> -Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm/Booting
> +[1] linux/Documentation/arm/booting.rst
> +Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm/booting.rst
> 
> -[2] linux/Documentation/arm64/booting.txt
> -Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm64/booting.txt
> +[2] linux/Documentation/arm64/booting.rst
> +Latest version: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/arm64/booting.rst
> diff --git a/docs/misc/arm/passthrough.txt b/docs/misc/arm/passthrough.txt
> index 219d1cca571b..4f0a024818a2 100644
> --- a/docs/misc/arm/passthrough.txt
> +++ b/docs/misc/arm/passthrough.txt
> @@ -71,8 +71,8 @@ Please refer to your platform docs for the MMIO ranges and interrupts.
> They can also be calculated from the original device tree (not
> recommended). You can read about the "interrupts" property format in the
> device tree bindings of the interrupt controller of your platform. For
> -example, in the case of GICv2 see [arm,gic.txt]; in the case of GICv3
> -see [arm,gic-v3.txt] in the Linux repository. For both GICv2 and GICv3
> +example, in the case of GICv2 see [arm,gic.yaml]; in the case of GICv3
> +see [arm,gic-v3.yaml] in the Linux repository. For both GICv2 and GICv3
> the "interrupts" property format is the same: the first cell is the
> interrupt type, and the second cell is the interrupt number.  Given that
> SPI numbers start from 32, in this example 80 + 32 = 112.
> @@ -187,6 +187,6 @@ assign a network card to a dom0-less guest on Xilinx Ultrascale+ MPSoC:
> };
> 
> 
> -[arm,gic.txt]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic.txt
> -[arm,gic-v3.txt]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic-v3.txt
> +[arm,gic.yaml]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic.yaml
> +[arm,gic-v3.yaml]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/interrupt-controller/arm,gic-v3.yaml
> [xl.cfg]: https://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html
> -- 
> 2.25.1
>

Re: [PATCH] docs/misc/arm: Update references to Linux kernel docs

Posted by Julien Grall 1 year, 4 months ago

(+ Henry)

Hi,

On 18/11/2022 13:10, Bertrand Marquis wrote:
> Hi Michal,
> 
>> On 18 Nov 2022, at 11:45, Michal Orzel <michal.orzel@amd.com> wrote:
>>
>> Some time ago, Linux switched the format of docs to ReST and the format
>> of device-tree bindings to json-schema.
>>
>> Signed-off-by: Michal Orzel <michal.orzel@amd.com>
> Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com>

This could potentially be a candidate for 4.17 as this is correcting the 
links in the docs. So risk free.

If we have no new bug fixed queued for 4.17, then I could add the patch 
after branching.

Cheers,

-- 
Julien Grall

RE: [PATCH] docs/misc/arm: Update references to Linux kernel docs

Posted by Henry Wang 1 year, 4 months ago

Hi Julien,

> -----Original Message-----
> From: Julien Grall <julien@xen.org>
> Subject: Re: [PATCH] docs/misc/arm: Update references to Linux kernel docs
> 
> (+ Henry)

Thanks.

> 
> Hi,
> 
> On 18/11/2022 13:10, Bertrand Marquis wrote:
> > Hi Michal,
> >
> >> On 18 Nov 2022, at 11:45, Michal Orzel <michal.orzel@amd.com> wrote:
> >>
> >> Some time ago, Linux switched the format of docs to ReST and the format
> >> of device-tree bindings to json-schema.
> >>
> >> Signed-off-by: Michal Orzel <michal.orzel@amd.com>
> > Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com>
> 
> This could potentially be a candidate for 4.17 as this is correcting the
> links in the docs. So risk free.

Agreed.

> 
> If we have no new bug fixed queued for 4.17, then I could add the patch
> after branching.

Sounds good to me, if you want to do that:

Release-acked-by: Henry Wang <Henry.Wang@arm.com>

Kind regards,
Henry


> 
> Cheers,
> 
> --
> Julien Grall

Re: [PATCH] docs/misc/arm: Update references to Linux kernel docs

Posted by Julien Grall 1 year, 4 months ago

Hi,

On 23/11/2022 02:24, Henry Wang wrote:
>> -----Original Message-----
>> From: Julien Grall <julien@xen.org>
>> Subject: Re: [PATCH] docs/misc/arm: Update references to Linux kernel docs
>>
>> (+ Henry)
> 
> Thanks.
> 
>>
>> Hi,
>>
>> On 18/11/2022 13:10, Bertrand Marquis wrote:
>>> Hi Michal,
>>>
>>>> On 18 Nov 2022, at 11:45, Michal Orzel <michal.orzel@amd.com> wrote:
>>>>
>>>> Some time ago, Linux switched the format of docs to ReST and the format
>>>> of device-tree bindings to json-schema.
>>>>
>>>> Signed-off-by: Michal Orzel <michal.orzel@amd.com>
>>> Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com>
>>
>> This could potentially be a candidate for 4.17 as this is correcting the
>> links in the docs. So risk free.
> 
> Agreed.
> 
>>
>> If we have no new bug fixed queued for 4.17, then I could add the patch
>> after branching.
> 
> Sounds good to me, if you want to do that:
> 
> Release-acked-by: Henry Wang <Henry.Wang@arm.com>

It is now committed.

Cheers,

-- 
Julien Grall