Xen devel - Feb 2012 - DOC-DAY: WIP for command line options documentation

Attached is an attempt to document all the Xen command line parameters.

Because of other tasks, (and choosing to document the rather twisty
''acpi'' option first), It is far less complete than I was
hoping.

However, I am submitting it so other people may benefit (and contribute)
going forward.

-- 
Andrew Cooper - Dom0 Kernel Engineer, Citrix XenServer
T: +44 (0)1223 225 900, http://www.citrix.com



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

On Mon, Feb 27, 2012 at 06:43:10PM +0000, Andrew Cooper
wrote:
> Attached is an attempt to document all the Xen command line parameters.
> 
> Because of other tasks, (and choosing to document the rather twisty
> ''acpi'' option first), It is far less complete than I was
hoping.
> 
> However, I am submitting it so other people may benefit (and contribute)
> going forward.
> 
Related link:
http://wiki.xen.org/wiki/Xen_Hypervisor_Boot_Options

-- Pasi

> -- 
> Andrew Cooper - Dom0 Kernel Engineer, Citrix XenServer
> T: +44 (0)1223 225 900, http://www.citrix.com
>

On 27/02/12 19:27, Pasi Kärkkäinen wrote:
> On Mon, Feb 27, 2012 at 06:43:10PM +0000, Andrew Cooper wrote:
>> Attached is an attempt to document all the Xen command line parameters.
>>
>> Because of other tasks, (and choosing to document the rather twisty
>> ''acpi'' option first), It is far less complete than I
was hoping.
>>
>> However, I am submitting it so other people may benefit (and
contribute)
>> going forward.
>>
> Related link:
> http://wiki.xen.org/wiki/Xen_Hypervisor_Boot_Options
>
> -- Pasi
Yes - I am aware of that, but sadly it is starting to get out of date. 
The idea of having a markdown document in the source tree is so any
patch modifying command line behavior should also patch this file, so
hopefully the document will stay up to date going forward.

~Andrew
>
>> -- 
>> Andrew Cooper - Dom0 Kernel Engineer, Citrix XenServer
>> T: +44 (0)1223 225 900, http://www.citrix.com
>>
>
-- 
Andrew Cooper - Dom0 Kernel Engineer, Citrix XenServer
T: +44 (0)1223 225 900, http://www.citrix.com

On Tue, 2012-02-28 at 09:40 +0000, Andrew Cooper wrote:
> On 27/02/12 19:27, Pasi Kärkkäinen wrote:
> > On Mon, Feb 27, 2012 at 06:43:10PM +0000, Andrew Cooper wrote:
> >> Attached is an attempt to document all the Xen command line
parameters.
> >>
> >> Because of other tasks, (and choosing to document the rather
twisty
> >> 'acpi' option first), It is far less complete than I was
hoping.
> >>
> >> However, I am submitting it so other people may benefit (and
contribute)
> >> going forward.
> >>
> > Related link:
> > http://wiki.xen.org/wiki/Xen_Hypervisor_Boot_Options
> >
> > -- Pasi
> 
> Yes - I am aware of that, but sadly it is starting to get out of date. 
> The idea of having a markdown document in the source tree is so any
> patch modifying command line behavior should also patch this file, so
> hopefully the document will stay up to date going forward.
A good starting point would be to cut-n-paste that wiki page into the
markdown docs and then replace the wiki page with a link to the
generated docs at http://xenbits.xen.org/docs . This would be preferable
to starting completely from scratch.

Aside; That wiki page's use of "Grub.conf options for Xen" vs
"Xen
Command Line" is pretty confusing, I think it is trying to say "Xen
Command Line" and "Dom0 Linux Kernel Command Line" respectively
but I
wasn't sure so I didn't want to touch it.

Ian.
> 
> ~Andrew
> 
> >
> >> -- 
> >> Andrew Cooper - Dom0 Kernel Engineer, Citrix XenServer
> >> T: +44 (0)1223 225 900, http://www.citrix.com
> >>
> >
> 


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

On Tue, Feb 28, 2012 at 09:47:00AM +0000, Ian Campbell
wrote:
> On Tue, 2012-02-28 at 09:40 +0000, Andrew Cooper wrote:
> > On 27/02/12 19:27, Pasi Kärkkäinen wrote:
> > > On Mon, Feb 27, 2012 at 06:43:10PM +0000, Andrew Cooper wrote:
> > >> Attached is an attempt to document all the Xen command line
parameters.
> > >>
> > >> Because of other tasks, (and choosing to document the rather
twisty
> > >> ''acpi'' option first), It is far less
complete than I was hoping.
> > >>
> > >> However, I am submitting it so other people may benefit (and
contribute)
> > >> going forward.
> > >>
> > > Related link:
> > > http://wiki.xen.org/wiki/Xen_Hypervisor_Boot_Options
> > >
> > > -- Pasi
> > 
> > Yes - I am aware of that, but sadly it is starting to get out of date.
> > The idea of having a markdown document in the source tree is so any
> > patch modifying command line behavior should also patch this file, so
> > hopefully the document will stay up to date going forward.
> 
> A good starting point would be to cut-n-paste that wiki page into the
> markdown docs and then replace the wiki page with a link to the
> generated docs at http://xenbits.xen.org/docs . This would be preferable
> to starting completely from scratch.
> 
Makes sense..
> Aside That wiki page''s use of "Grub.conf options for
Xen" vs "Xen
> Command Line" is pretty confusing, I think it is trying to say
"Xen
> Command Line" and "Dom0 Linux Kernel Command Line"
respectively but I
> wasn''t sure so I didn''t want to touch it.
> 
I think there is (or at least was on the old wiki) a page listing all the dom0
kernel options.

So the Xen_Hypervisor_Boot_Options has only Xen (xen.gz) options.

-- Pasi
> Ian.
> 
> > 
> > ~Andrew
> > 
> > >
> > >> -- 
> > >> Andrew Cooper - Dom0 Kernel Engineer, Citrix XenServer
> > >> T: +44 (0)1223 225 900, http://www.citrix.com
> > >>
> > >
> > 
> 
>

Ian Campbell writes ("Re: [Xen-devel] DOC-DAY: WIP for command line options
documentation"):
> A good starting point would be to cut-n-paste that wiki page into the
> markdown docs and then replace the wiki page with a link to the
> generated docs at http://xenbits.xen.org/docs . This would be preferable
> to starting completely from scratch.
I agree but I''m reluctant to let the best be the enemy of the good.

Perhaps it would be best to commit Andrew Cooper''s version into the
tree and then dump the wiki page into it later if and when someone
gets around to submitting such a patch ?

Ian.

On 01/03/12 16:28, Ian Jackson wrote:
> Ian Campbell writes ("Re: [Xen-devel] DOC-DAY: WIP for command line
options documentation"):
>> A good starting point would be to cut-n-paste that wiki page into the
>> markdown docs and then replace the wiki page with a link to the
>> generated docs at http://xenbits.xen.org/docs . This would be
preferable
>> to starting completely from scratch.
> I agree but I''m reluctant to let the best be the enemy of the
good.
>
> Perhaps it would be best to commit Andrew Cooper''s version into
the
> tree and then dump the wiki page into it later if and when someone
> gets around to submitting such a patch ?
>
> Ian.
I got half way through dumping the (relevant parts of) wiki page into my
patch, but got interrupted by a support ticket.

When I have completed that, I will resubmit the patch.

-- 
Andrew Cooper - Dom0 Kernel Engineer, Citrix XenServer
T: +44 (0)1223 225 900, http://www.citrix.com

Andrew Cooper writes ("Re: [Xen-devel] DOC-DAY: WIP for command line
options documentation"):
> I got half way through dumping the (relevant parts of) wiki page into my
> patch, but got interrupted by a support ticket.
> 
> When I have completed that, I will resubmit the patch.
Excellent, thanks!

Ian.