aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* flask/policy: Add boolean exampleDaniel De Graaf2012-02-021-1/+2
| | | | | | | | | This shows an example boolean (prot_doms_locked) which can be set at runtime to prevent dom0 from mapping memory of domains of type prot_domU_t. Signed-off-by: Daniel De Graaf <dgdegra@tycho.nsa.gov> Committed-by: Keir Fraser <keir@xen.org>
* flask/policy: Add user and constraint examplesDaniel De Graaf2012-02-021-10/+32
| | | | | | | | | These examples show how to use constraints and the user field of the security label to prevent communication between virtual machines of different customers in a multi-tenant environment. Signed-off-by: Daniel De Graaf <dgdegra@tycho.nsa.gov> Committed-by: Keir Fraser <keir@xen.org>
* xl: allow enable automatic fallback to ACPI events if PV control not available.Ian Campbell2012-01-311-4/+28
| | | | | | | | | | | | | Add a -F (fallbacks) option to xl destroy|reboot to cause an ACPI shutdown or reset event to be sent to the guest in the event that the guest does not support the PV control interface. This is not the default because the response to these triggers is an guest-internal configuration. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs: document /etc/xen/xl.confIan Campbell2012-01-311-0/+93
| | | | | | Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* libxl: remove libxl_button_press in favour of libxl_send_trigger.Ian Campbell2012-01-311-1/+3
| | | | | | | | | | | | | send_trigger already included all the operations covered by button_press. Rework send_trigger to take an enum instead of a string. I stopped short at removing the xl "button-press" command but instead have marked it as deprecated. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Acked-by: Ian Jackson <Ian.Jackson@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* Tools: Add a sharing command to xl for information about shared pagesAndres Lagar-Cavilla2012-01-261-0/+13
| | | | | | | | | | | Also add the global sharing statistics to the libxl physinfo. This is a slight departure from libxc, but there's no reason libxl physinfo can't include extra bits of useful and relevant information. Signed-off-by: Andres Lagar-Cavilla <andres@lagarcavilla.org> Signed-off-by: Adin Scannell <adin@scannell.ca> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Tim Deegan <tim@xen.org>
* docs: Remove outdated LaTex documentation.Keir Fraser2012-01-255-5518/+3
| | | | Signed-off-by: Keir Fraser <keir@xen.org>
* docs: xl.pod.1: introduction to FLASKStefano Stabellini2012-01-101-3/+17
| | | | | | | | | | | | | Add a simple introduction to FLASK to the xl man page, at the beginning of the FLASK chapter. Link to the xsm-flask.txt document. Currently FLASK, TMEM and PCI PASS-THROUGH are defined as =head2 so they look like sub-chapters of VIRTUAL DEVICE COMMANDS. Make them =head1. Based on a text written by Daniel De Graaf. Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Signed-off-by: Daniel De Graaf <dgdegra@tycho.nsa.gov> Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
* docs: Update xsm-flask documentationDaniel De Graaf2012-01-101-144/+96
| | | | | Signed-off-by: Daniel De Graaf <dgdegra@tycho.nsa.gov> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* libxl: report failure to reboot/shutdown due to lackof PV interfaces to callerIan Campbell2011-12-211-4/+14
| | | | | | | | | | | | This allow the caller to react as they think is appropriate. xl now prints a message much like the library did previously, although hopefully somewhat more informative. Update the xl(1) man page to be similarly more informative. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* xl.pod.1: improve documentation of FLASK commandsDaniel De Graaf2011-12-181-16/+22
| | | | Signed-off-by: Daniel De Graaf <dgdegra@tycho.nsa.gov>
* docs: Say in xm(1) that xm is obsoleteIan Jackson2011-12-081-5/+9
| | | | | Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com>
* Support of xl sched-sedfJuergen Gross2011-11-281-0/+42
| | | | | | | | | | | | Supports the xl subcommand sched-sedf. The man page is only a minimal version (copy from xm man page without examples). BTW: the xm man page seems not to be in sync with xm sched-sedf -h regarding the time units. I used milliseconds in the xl implementation. Only minimal semantical checks of parameters. Signed-off-by: juergen.gross@ts.fujitsu.com Acked-by: Ian Jackson <ian.jackson.citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* Support of xl sched-credit2Juergen Gross2011-11-281-0/+29
| | | | | | | | Supports the xl subcommand sched-credit2. Signed-off-by: juergen.gross@ts.fujitsu.com Acked-by: Ian Jackson <ian.jackson.citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* Support cpupools in xl sched-creditJuergen Gross2011-11-281-0/+4
| | | | | | | | | | | | | Adds cpupool awareness to output of xl sched-credit. Output can now be restricted to a specific cpupool. The domains are printed for each cpupool seperately. The loop over cpupools and domains is seperated from the main command implementation to be able to support other schedulers as well. Signed-off-by: juergen.gross@ts.fujitsu.com Acked-by: Ian Jackson <ian.jackson.citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* xl sched-credit: support long optionsJuergen Gross2011-11-281-5/+10
| | | | | | | | | The help text of xl sched-credit supported long options. Neither the man page nor the implementation did. Signed-off-by: juergen.gross@ts.fujitsu.com Acked-by: Ian Jackson <ian.jackson.citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* xl.pod.1: add a note about autoballoon and dom0_memStefano Stabellini2011-12-011-0/+16
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: add a refence to http://wiki.xen.org/xenwiki/ReportingBugsStefano Stabellini2011-12-011-1/+2
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: remove AUTHORS sectionStefano Stabellini2011-12-011-7/+0
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: improve description of virtual device subcommandsStefano Stabellini2011-12-011-6/+15
| | | | | | | Add a reference to xl-disk-configuration and xl-network-configuration. Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: remove dry-run option from create and cpupool-createStefano Stabellini2011-12-011-9/+0
| | | | | | | | there is already a global dry-run option, there is no point in adding another one for each subcommand Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: improve the description of pci-list-assignable-devicesStefano Stabellini2011-12-011-0/+3
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: improve the description of the info subcommandStefano Stabellini2011-12-011-26/+29
| | | | | | | also update the example Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: improve the debug-keys subcommand descriptionStefano Stabellini2011-12-011-1/+2
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: introduce a TO BE DOCUMENTED sectionStefano Stabellini2011-12-011-0/+16
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: state when a subcommand is only available to HVM guestsStefano Stabellini2011-12-011-1/+2
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: better description for the sysreq subcommandStefano Stabellini2011-12-011-3/+5
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: state when a command requires PV drivers installedStefano Stabellini2011-12-011-4/+2
| | | | | | | | Remove an old incorrect comment about vcpu-set requiring cooperation from the guest. Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: add a reference to create in the -e optionStefano Stabellini2011-12-011-1/+2
| | | | | | | | Add a reference to the create subcommand in the description of the -e option to unpause and migrate. Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: remove the two FIXMEStefano Stabellini2011-12-011-3/+2
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: order subcommands alphabeticallyStefano Stabellini2011-12-011-30/+29
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: add a description of the global optionsStefano Stabellini2011-12-011-0/+16
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: improve create documentationStefano Stabellini2011-12-011-6/+15
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: add a description of console optionsStefano Stabellini2011-12-011-1/+18
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* xl.pod.1: add a barebone description of tmem commandsStefano Stabellini2011-12-011-0/+66
| | | | | Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs: implement uniq instead of depending on List::MoreUtilsIan Campbell2011-12-011-1/+6
| | | | | Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
* docs: improve index.html generationIan Campbell2011-11-292-8/+13
| | | | | | | | | | | | | | Include hypercall documentation, fixing link generation for top level links to use the INDEX. Allow subsection links to be renamedi in the INDEX too. Strip .txt suffixes as well as .html ones by moving the regex to the right place instead of placing the literal text "(?:html|txt)" into the backlink to the top level page. (oops) Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
* docs/html/: Arrange for automatic build of hypercall docsIan Jackson2011-11-292-3/+20
| | | | | | | | | | - Use index.html rather than a stamp file. - Automatically generate dependencies. - Wire into the docs build system Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs/html/: Generate an "index.html" for hypercall docsIan Jackson2011-11-291-0/+59
| | | | | | | | Generate an "index.html" containing various useful links. Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs/html/: Annotations for two hypercallsIan Jackson2011-11-291-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | Add annotations for a couple of the hypercalls: HYPERVISOR_set_trap_table HYPERVISOR_mmu_update We do this by * annotating the list of #defines for hypercall numbers * annotating the list of error values * providing a function prototype for the systematically-named functions The header generator does the rest. This exercise revealed a couple of infelicities: * In the actual source code, do_mmu_update is defined to return an int and do_set_trap_table a long. However both functions return either -Efoo (on error) or 0 for success. * The error numbers are defined only in the private header file xen/include/xen/errno.h and then only with names which will typically clash with other projects. It would be nice to include a public version of this header which defines XEN_E*. But for now we run xen-headers on errno.h too. Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs/html/: Initial cut of header documentation massagerIan Jackson2011-11-292-0/+300
| | | | | | | | | | | | | "xen-headers" generates HTML from header files. So far this generates just some type cross-references, if you say make -C docs html/hypercall/stamp An index page, proper wiring into the build system, and a few more annotations in the headers, and will be forthcoming. Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs: improve documantion of xl's viridian optionIan Campbell2011-11-291-1/+7
| | | | | | Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: install txt files as htmlIan Campbell2011-11-292-1/+8
| | | | | | | | A browser will display them just fine. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* xl: make bootloader_args a listIan Campbell2011-11-291-3/+4
| | | | | | | | | | This is much more natural. Continue to support the old syntax in xl but deprecate it. [ Fixed up a long line in xl_cmdimpl.c. -iwj ] Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
* docs: move user and interface .tex documents under reference.Ian Campbell2011-11-292-6/+6
| | | | | | | | | | | | | | Taking over the top level "user" entry with a relatively obsolete document is a bit of an annoyance but these docs are not so out of date that they should be deleted. Move them out of the top-level instead. (the original motivation here was to allow for user/xl-domain-cfg.markdown but we have since decided to go with man/xl.cfg.pod.5 instead so perhaps this is a waste of time) Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: generate an index for the html outputIan Campbell2011-11-293-1/+145
| | | | | | | | nb: I'm not a Perl wizard... Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: tweak markup and wording of qemu upstream doc slightlyIan Campbell2011-11-291-14/+15
| | | | | | Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: remove non-breaking spaces from sedf_scheduler_mini-HOWTO.txtIan Campbell2011-11-291-25/+25
| | | | | | | | | | | | | | | | This document contains several 0xa0 characters (non-breaking spaces). These do not display correctly in (some) terminals or when the document is rendered by (some) browsers. Re-encode them as spaces. I'm not confident that this change will make it through being encoded as a patch and sent through email. Its effect can be replicated with: perl -i -p -e 's/\xa0/ /g' docs/misc/sedf_scheduler_mini-HOWTO.txt [ I ran the rune rather than trying to apply the patch -iwj ] Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
* libxl: use named options for tsc_mode.Ian Campbell2011-11-291-1/+35
| | | | | | | | | Add an enum at the libxl level with a hopefully descriptive set of names. Deprecate the use of an integer in xl cfg files. Signed-off-by: Ian Campbell Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: add a document describing the xl cfg file syntaxIan Campbell2011-11-292-12/+856
| | | | | | | | | | | | | | | | | | Based on an initial version by Ian Jackson. I believe that all keys are now present in the document although there are are various omissions in the actual documentation of them. Hopefully however this covers the majority of the most interesting keys. Spice section: Signed-off-by: Zhou Peng <zhoupeng@nfs.iscas.ac.cn> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com> The rest: Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-16 08:28:16 +0000