| |
|
 |
|
 |
|
|
|
| |
|
|
xen-devel
Re: [Xen-devel] [PATCH] add man pages to xen
> The following patch adds the beginnings of man pages to xen, specifically
> the xmdomain.cfg.5 man page, and a very small stub for xm.1, plus the build
> elements required. This is done using the pod (plain old text) markup and
> converting to man format with pod2man. If people like this, expect more
> work in the future to fill out these man pages as well as others.
I do like the idea of getting some manpages in.
The only danger is that of inconsistent documentation. Hopefully the docs
will stay consistent with each other and with the tools themselves :-) The
user manual is getting some attention, I believe, so that should help.
That said, it might be nice if we could somehow unify the command / config
option help that's present in main.py and create.py of the xm package to
either be generated from the docs or vice versa. Don't want to
overcomplicate the build process but it'd be unfortunate to duplicate all
this stuff.
> +Domain configuration files live in /etc/xen by default, though the
> +full path to the config file must be specified in the I<xm create>
> +command, so they can exist anywhere in the filesystem.
Minor point: I think if you don't use -f, the default search path is
in /etc/xen.
Personally, I'd also suggest that we actually patch the relevant files in the
tools with a prominent warning reminding people what docs they should update
when they touch those files (just as we put a big warning telling people to
change the XC interface version when updating dom0_ops.c).
Cheers,
Mark
_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel
|
|
|
| |
|
Home