diff mbox series

docs/efi: Fix wrong compatible in dts example

Message ID 20211202150517.53029-1-luca.fancellu@arm.com (mailing list archive)
State Accepted
Headers show
Series docs/efi: Fix wrong compatible in dts example | expand

Commit Message

Luca Fancellu Dec. 2, 2021, 3:05 p.m. UTC
The example in section "UEFI boot and dom0less on ARM" has
a wrong compatible for the DTB passthrough, it is "ramdisk"
instead of "device-tree".
This patch fixes the example.

Fixes: a1743fc3a9 ("arm/efi: Use dom0less configuration when using EFI boot")
Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>
---
Question: Does it makes sense to backport it to 4.16?
---
 docs/misc/efi.pandoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bertrand Marquis Dec. 2, 2021, 3:24 p.m. UTC | #1
Hi Luca,

> On 2 Dec 2021, at 15:05, Luca Fancellu <Luca.Fancellu@arm.com> wrote:
> 
> The example in section "UEFI boot and dom0less on ARM" has
> a wrong compatible for the DTB passthrough, it is "ramdisk"
> instead of "device-tree".
> This patch fixes the example.
> 
> Fixes: a1743fc3a9 ("arm/efi: Use dom0less configuration when using EFI boot")
> Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>
Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com>

> ---
> Question: Does it makes sense to backport it to 4.16?

I would vote for that yes.

Regards
Bertrand

> ---
> docs/misc/efi.pandoc | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/misc/efi.pandoc b/docs/misc/efi.pandoc
> index 4abbb5bb82..abafb34527 100644
> --- a/docs/misc/efi.pandoc
> +++ b/docs/misc/efi.pandoc
> @@ -222,7 +222,7 @@ domU1 {
> 		xen,uefi-binary = "initrd-3.0.31-0.4-xen";
> 	};
> 	module@3 {
> -		compatible = "multiboot,ramdisk", "multiboot,module";
> +		compatible = "multiboot,device-tree", "multiboot,module";
> 		xen,uefi-binary = "passthrough.dtb";
> 	};
> };
> -- 
> 2.17.1
> 
>
Julien Grall Dec. 3, 2021, 12:45 p.m. UTC | #2
Hi Luca,

I have committed the patch with a couple of changes.

On 02/12/2021 15:05, Luca Fancellu wrote:
> The example in section "UEFI boot and dom0less on ARM" has
> a wrong compatible for the DTB passthrough, it is "ramdisk"
> instead of "device-tree".
> This patch fixes the example.

I have re-wrapped the commit message to 72-characters rather than 
58-characters.

> 
> Fixes: a1743fc3a9 ("arm/efi: Use dom0less configuration when using EFI boot")

The sha1 should be 12-characters for Fixes tag. You can configure git to 
ouput one for you. See [1] for more details.

> Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Acked-by: Julien Grall <jgralL@amazon.com>

> ---
> Question: Does it makes sense to backport it to 4.16?

I think so. I would tend to read the same documentation as the version
of Xen I am using. Documentation patches are also not considered risky.

Stefano can you add it in your backport list?

[1] https://xenbits.xen.org/docs/unstable/process/tags.html
diff mbox series

Patch

diff --git a/docs/misc/efi.pandoc b/docs/misc/efi.pandoc
index 4abbb5bb82..abafb34527 100644
--- a/docs/misc/efi.pandoc
+++ b/docs/misc/efi.pandoc
@@ -222,7 +222,7 @@  domU1 {
 		xen,uefi-binary = "initrd-3.0.31-0.4-xen";
 	};
 	module@3 {
-		compatible = "multiboot,ramdisk", "multiboot,module";
+		compatible = "multiboot,device-tree", "multiboot,module";
 		xen,uefi-binary = "passthrough.dtb";
 	};
 };