Re: [PATCH] x86-64/EFI: document building and usage

[Ian Campbell <Ian.Campbell@citrix.com>]

On Wed, 2012-06-20 at 12:56 +0100, Jan Beulich wrote:
> >>> On 20.06.12 at 13:35, Ian Campbell <Ian.Campbell@citrix.com> wrote:
> > On Wed, 2012-06-20 at 08:36 +0100, Jan Beulich wrote:
> >> Signed-off-by: Jan Beulich <jbeulich@suse.com>
> > 
> > The text looks fine to me, thanks. One comment inline below.
> > 
> > Did you consider using markdown syntax to get a somewhat formatted HTML
> > output? You'd basically just need to s/.txt/.markdown/ and tweak things
> > a bit to use the markdown syntax (which is designed to mostly follow the
> > sorts of ASCII typographical conventions which people use anyway).
> > 
> > http://daringfireball.net/projects/markdown/ 
> 
> I didn't consider this, but I can certainly convert it if that's what
> is preferred these days.

I think it's generally preferred for new stuff if the author is willing
(i.e. we'd still rather have .txt than nothing)

> >> +**************************example begin******************************
> >> +[global]
> >> +default=sle11sp2
> >> +
> >> +[sle11sp2]
> >> +options=console=vga,com1 com1=57600 loglvl=all noreboot
> >> +kernel=vmlinuz-3.0.31-0.4-xen ignore_loglevel #earlyprintk=xen
> >> +ramdisk=initrd-3.0.31-0.4-xen
> >> +**************************example end********************************
> >> +
> >> +Other values to specify are
> > 
> > As well as "Other values" I think you need to document the ones above as
> > well.
> 
> Hmm, I would think anyone half way familiar with Xen can interpret
> the meaning of the four ones used above without extra explanation.

The problem is more those which aren't familiar with Xen who think they
want to deploy it using EFI, for whatever reason.

> I don't intend this small piece of text to be a reference document,
> but just an aid to people (having got tired of individuals contacting
> me namely about how to build xen.efi, despite all the information
> being available already - just scattered around).

Sure. Documenting those three options will help with that too, won't it?
I'd expect that getting pestered by those who can't figure that sort of
thing out would be doubly annoying!

I don't think it'll take more than a line to document each one, a link
to http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html might
be useful too.