Re: [Xen-devel] [PATCH 6/8] docs: Document the dom0_vga_console_info structure.

[Ian Campbell <Ian.Campbell@xxxxxxxxxx>]

On Mon, 2013-01-28 at 18:32 +0000, Konrad Rzeszutek Wilk wrote:
> Mark-up for inclusion of generated docs.
> 
> Signed-off-by: Konrad Rzeszutek Wilk <konrad.wilk@xxxxxxxxxx>
> ---
>  xen/include/public/xen.h | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/xen/include/public/xen.h b/xen/include/public/xen.h
> index e1748d1..c50bbfc 100644
> --- a/xen/include/public/xen.h
> +++ b/xen/include/public/xen.h
> @@ -779,7 +779,15 @@ struct xen_multiboot_mod_list
>      /* Unused, must be zero */
>      uint32_t pad;
>  };
> -
> +/*
> + * `incontents 200 startofday_dom0_console Dom9_console
> + *
> + * The console structure in start_info.console.dom0
> + *
> + * The contents off this structure follows mostly the Linux kernel
> + * bootparam structure and includes a variety of information required
> + * to have a working VGA/VESA console.

Would it be useful to either link to the bootparam structure information
or to explain from first principals? I suppose the existing fields are
actually reasonably well commented.

NB, ./arch/x86/include/uapi/asm/bootparam.h doesn't seem to have a
literal struct bootparam so I guess you are referring to something else?
There is a struct boot_params but it doesn't really match what is here.
There is a struct screen_info in Linux but it isn't a good match for
this Xen structure either.

Are you sure it mostly follows a Linux bootparam structure? Maybe it
would be easiest to just say:

        This structure includes a variety of information required to
        have a working VGA/VESA console.
        
?



_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel