mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 02:01:24 +01:00
Andrew Cooper
8410fcb54a
The original intent of this patch was to rename xen-vbd-interface.markdown.7 to xen-vbd-interface.pandoc.7 to remove the final markdown file from the docs/ tree. The DOC_MANx lists are broken. They contain MANxSRC-y twice, the first half with a partial %.pod substituation, and the second half with a partial %.markdown substitution. This is also the root cause behind the filtering activity in the uninstall-man$(i)-pages rule. Furthermore, the logic for generating the manpage targets is unnecesserily repetative, owing to the layout of source files in the man/ directory. Therefore, tackle the problem by renaming all of our manpage source files from "$FORMAT.$SECTION" to "$SECTION.$FORMAT". For the two xl.cfg.5 and xl.1 which are preprocessed by autoconf to contain path information, this requires updating configure.ac and .gitignore. The markdown to pandoc conversion is performed as well, as it is also a straight rename. An ancillary benefit of this renaming is that text editors stand a chance of being able to work out the correct mode to use. As for the makefile: 1) Break the MAN_SECTIONS list out of the GENERATE_MANPAGE_RULES loop, as we are going to use it a second time. 2) Do away with the individaul MANxSRC-y variables. Use a single list, derived from all *.pod and *.pandoc files, with their format suffixes removed. 3) Use a $(foreach ...) to generate the DOC_MANx lists, filling them with the correct content. 4) The DOC_HTML and DOC_TXT can now include all manpages with a single substitution, as they don't need to separate the manpages by section-numbered-directory. 5) Fix up the filenames in the manpage metarule to match the renaming. No functional change. Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
134 lines
2.8 KiB
INI
134 lines
2.8 KiB
INI
=head1 NAME
|
|
|
|
xlcpupool.cfg - XL Cpupool Configuration File Syntax
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
/etc/xen/xlcpupool
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
To create a Cpupool with xl requires the provision of a cpupool config
|
|
file. Typically these live in `/etc/xen/CPUPOOL.cfg` where CPUPOOL is
|
|
the name of the cpupool.
|
|
|
|
=head1 SYNTAX
|
|
|
|
A cpupool config file consists of a series of C<KEY=VALUE> pairs.
|
|
|
|
A value C<VALUE> is one of:
|
|
|
|
=over 4
|
|
|
|
=item B<"STRING">
|
|
|
|
A string, surrounded by either single or double quotes.
|
|
|
|
=item B<NUMBER>
|
|
|
|
A number, in either decimal, octal (using a C<0> prefix) or
|
|
hexadecimal (using an C<0x> prefix).
|
|
|
|
=item B<[ VALUE, VALUE, ... ]>
|
|
|
|
A list of C<VALUES> of the above types. Lists are homogeneous and are
|
|
not nested.
|
|
|
|
=back
|
|
|
|
The semantics of each C<KEY> defines which form of C<VALUE> is required.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=head2 Mandatory Configuration Items
|
|
|
|
The following key is mandatory for any cpupool:
|
|
|
|
=over 4
|
|
|
|
=item B<name="NAME">
|
|
|
|
Specifies the name of the cpupool. Names of cpupools existing on a
|
|
single host must be unique.
|
|
|
|
=back
|
|
|
|
=head2 Optional Configuration Items
|
|
|
|
The following options apply to guests of any type.
|
|
|
|
=over 4
|
|
|
|
=item B<sched="SCHED">
|
|
|
|
Specifies the scheduler which is used for the cpupool. Valid
|
|
values for C<SCHED> are:
|
|
|
|
=over 4
|
|
|
|
=item B<credit>
|
|
|
|
the credit scheduler
|
|
|
|
=item B<credit2>
|
|
|
|
the credit2 scheduler
|
|
|
|
=item B<rtds>
|
|
|
|
the RTDS scheduler
|
|
|
|
=back
|
|
|
|
The default scheduler is the one used for C<Pool-0> specified as
|
|
boot parameter of the hypervisor.
|
|
|
|
=item B<nodes="NODES">
|
|
|
|
Specifies the cpus of the NUMA-nodes given in C<NODES> (an integer or
|
|
a list of integers) to be member of the cpupool. The free cpus in the
|
|
specified nodes are allocated in the new cpupool.
|
|
|
|
=item B<cpus="CPU-LIST">
|
|
|
|
Specifies the cpus that will be member of the cpupool. All the specified
|
|
cpus must be free, or creation will fail. C<CPU-LIST> may be specified
|
|
as follows:
|
|
|
|
=over 4
|
|
|
|
=item ["2", "3", "5"]
|
|
|
|
means that cpus 2,3,5 will be member of the cpupool.
|
|
|
|
=item "0-3,5,^1"
|
|
|
|
means that cpus 0,2,3 and 5 will be member of the cpupool. A "node:" or
|
|
"nodes:" modifier can be used. E.g., "0,node:1,nodes:2-3,^10-13" means
|
|
that pcpus 0, plus all the cpus of NUMA nodes 1,2,3 with the exception
|
|
of cpus 10,11,12,13 will be memeber of the cpupool.
|
|
|
|
=back
|
|
|
|
If neither B<nodes> nor B<cpus> are specified only the first free cpu
|
|
found will be allocated in the new cpupool.
|
|
|
|
=back
|
|
|
|
=head1 FILES
|
|
|
|
F</etc/xen/CPUPOOL.cfg>
|
|
|
|
=head1 BUGS
|
|
|
|
This document is a work in progress and contains items which require
|
|
further documentation and which are generally incomplete (marked with
|
|
XXX). However all options are included here whether or not they are
|
|
fully documented.
|
|
|
|
Patches to improve incomplete items (or any other item) would be
|
|
gratefully received on the xen-devel@lists.xen.org mailing
|
|
list. Please see L<http://wiki.xen.org/wiki/SubmittingXenPatches> for
|
|
information on how to submit a patch to Xen.
|
|
|