From 57b78691f8d42101844d3e8df9c52d863d22304f Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Mon, 23 May 2016 12:29:28 +0200 Subject: [PATCH] update generated docs --- api-viewer/apidata.js | 17 +++++++++++------ pct.1-synopsis.adoc | 6 +++--- pct.conf.5-opts.adoc | 2 +- qm.conf.5-opts.adoc | 11 +++++------ 4 files changed, 20 insertions(+), 16 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 81a2327..a8611a5 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -5221,7 +5221,8 @@ var pveapi = [ "description" : "Map host PCI devices into guest.", "format" : "pve-qm-hostpci", "optional" : 1, - "type" : "string" + "type" : "string", + "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { "default" : "network,disk,usb", @@ -6287,7 +6288,7 @@ var pveapi = [ "optional" : 1, "pattern" : "(/dev/.+|socket)", "type" : "string", - "verbose_description" : "\nCreate a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "shares" : { "default" : 1000, @@ -6866,7 +6867,8 @@ var pveapi = [ "description" : "Map host PCI devices into guest.", "format" : "pve-qm-hostpci", "optional" : 1, - "type" : "string" + "type" : "string", + "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { "default" : "network,disk,usb", @@ -7932,7 +7934,7 @@ var pveapi = [ "optional" : 1, "pattern" : "(/dev/.+|socket)", "type" : "string", - "verbose_description" : "\nCreate a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "shares" : { "default" : 1000, @@ -10395,7 +10397,8 @@ var pveapi = [ "description" : "Map host PCI devices into guest.", "format" : "pve-qm-hostpci", "optional" : 1, - "type" : "string" + "type" : "string", + "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { "default" : "network,disk,usb", @@ -11461,7 +11464,7 @@ var pveapi = [ "optional" : 1, "pattern" : "(/dev/.+|socket)", "type" : "string", - "verbose_description" : "\nCreate a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" + "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "shares" : { "default" : 1000, @@ -12169,6 +12172,7 @@ var pveapi = [ "opensuse", "archlinux", "alpine", + "gentoo", "unmanaged" ], "optional" : 1, @@ -15598,6 +15602,7 @@ var pveapi = [ "opensuse", "archlinux", "alpine", + "gentoo", "unmanaged" ], "optional" : 1, diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 411541a..2dee78a 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -143,7 +143,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: +`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -506,7 +506,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: +`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. @@ -663,7 +663,7 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: +`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc index 418a7ff..0c165fe 100644 --- a/pct.conf.5-opts.adoc +++ b/pct.conf.5-opts.adoc @@ -134,7 +134,7 @@ Network interface type. Specifies whether a VM will be started during system bootup. -`ostype`: `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: +`ostype`: `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index e29c0bd..6e007a8 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -77,6 +77,11 @@ Freeze CPU at startup (use 'c' monitor command to start execution). `hostpci[n]`: `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: Map host PCI devices into guest. ++ +NOTE: This option allows direct access to host hardware. So it is no longer +possible to migrate such machines - use with special care. ++ +CAUTION: Experimental! User reported problems with this option. `host`=`` ;; @@ -86,11 +91,6 @@ of PCI virtual functions of the host. HOSTPCIID syntax is: 'bus:dev.func' (hexadecimal numbers) + You can us the 'lspci' command to list existing PCI devices. -+ -NOTE: This option allows direct access to host hardware. So it is no longer -possible to migrate such machines - use with special care. -+ -CAUTION: Experimental! User reported problems with this option. `pcie`=`boolean` (default=`0`);; @@ -667,7 +667,6 @@ SCSI controller model `serial[n]`: `(/dev/.+|socket)` :: -+ Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host side (use 'qm terminal' to open a terminal connection). -- 2.39.2