From nobody Thu May 2 17:46:28 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 150057523763048.68220872682821; Thu, 20 Jul 2017 11:27:17 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 0B0DE61E53; Thu, 20 Jul 2017 18:27:14 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DF3C360E3F; Thu, 20 Jul 2017 18:27:12 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id D46E44A492; Thu, 20 Jul 2017 18:27:09 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id v6KILmQr002288 for ; Thu, 20 Jul 2017 14:21:48 -0400 Received: by smtp.corp.redhat.com (Postfix) id D228C18223; Thu, 20 Jul 2017 18:21:48 +0000 (UTC) Received: from mx1.redhat.com (ext-mx09.extmail.prod.ext.phx2.redhat.com [10.5.110.38]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CC4B017F5E for ; Thu, 20 Jul 2017 18:21:46 +0000 (UTC) Received: from mail-wr0-f200.google.com (mail-wr0-f200.google.com [209.85.128.200]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 80D9E6573F for ; Thu, 20 Jul 2017 18:21:46 +0000 (UTC) Received: by mail-wr0-f200.google.com with SMTP id w63so13944462wrc.5 for ; Thu, 20 Jul 2017 11:21:46 -0700 (PDT) Received: from localhost.localdomain (ip-94-112-73-67.net.upcbroadband.cz. [94.112.73.67]) by smtp.gmail.com with ESMTPSA id l8sm3119988wmd.15.2017.07.20.11.21.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 20 Jul 2017 11:21:43 -0700 (PDT) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 0B0DE61E53 Authentication-Results: ext-mx10.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx10.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=libvir-list-bounces@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 0B0DE61E53 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=shIWlEw84p2ebJIogHaJQ7QOUEF8zKjqxeha4YZdD0E=; b=iNBaJOweqsQyWEjwdEwV9qtN91zc433fvryv1B9ffwIAg8q3xDdP6eHr4l7Qk3J2dD 6/KLetmgmvF6CMMjOKtytU4E73VpxfYWPohToF/BtG2nVm8Uz/SZSNFYPoO5LRJDQGPe n/PKmjhsKPxaNIZe6x/cIIULVlIs8iWzOrqOWvcO/2i7CmvII5oli1XxXzZ3lP5x0m4J NxfL0kIEJLAPs/9YgRZGOQd+1lAXFs22/drRcsa5BZgz6ab8Eu3F3M9wczK8xaQhJyQF 7go2RH3ZpjA2QXn92I69ET7DR50/qrXMRDxWxrIyoCF6t1RPxQQL+AbcGfREo16V+JD1 au6Q== X-Gm-Message-State: AIVw112oH+ln1i1iO5foG16qmFwqctBKj5nQe2+FHeYz7MGgmmr1lqr3 bEiCiKc/s7YFrKNihvUHNs3PlW2Qws6d8jsE28kB1A+GK4bEpHk1TfD9rRCMMr4KNTfc5UQLvPn T3FuTluX16A597Xo= X-Received: by 10.28.130.132 with SMTP id e126mr3169993wmd.107.1500574904711; Thu, 20 Jul 2017 11:21:44 -0700 (PDT) X-Received: by 10.28.130.132 with SMTP id e126mr3169979wmd.107.1500574904313; Thu, 20 Jul 2017 11:21:44 -0700 (PDT) From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Golembiovsk=C3=BD?= To: libvir-list@redhat.com Date: Thu, 20 Jul 2017 20:21:42 +0200 Message-Id: <4872bf4b1edd2f3cb7f9da8a37ee5c8029a60ae1.1500574862.git.tgolembi@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com Cc: =?UTF-8?q?Tom=C3=A1=C5=A1=20Golembiovsk=C3=BD?= Subject: [libvirt] [PATCH] docs: fix documentation of enum constants X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.39]); Thu, 20 Jul 2017 18:27:15 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 The documentation string has to follow the definition of a constant in the enum. Otherwise, the HTML documentation will be generated incorrectly. Signed-off-by: Tom=C3=A1=C5=A1 Golembiovsk=C3=BD --- include/libvirt/libvirt-domain.h | 62 ++++++++++++++++++++----------------= ---- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 45f939a8c..2f3162d0f 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -583,56 +583,56 @@ typedef virDomainInterfaceStatsStruct *virDomainInter= faceStatsPtr; * Memory Statistics Tags: */ typedef enum { - /* The total amount of data read from swap space (in kB). */ VIR_DOMAIN_MEMORY_STAT_SWAP_IN =3D 0, - /* The total amount of memory written out to swap space (in kB). */ + /* The total amount of data read from swap space (in kB). */ VIR_DOMAIN_MEMORY_STAT_SWAP_OUT =3D 1, + /* The total amount of memory written out to swap space (in kB). */ =20 + VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT =3D 2, + VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT =3D 3, /* * Page faults occur when a process makes a valid access to virtual me= mory * that is not available. When servicing the page fault, if disk IO is * required, it is considered a major fault. If not, it is a minor fa= ult. * These are expressed as the number of faults that have occurred. */ - VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT =3D 2, - VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT =3D 3, =20 + VIR_DOMAIN_MEMORY_STAT_UNUSED =3D 4, /* * The amount of memory left completely unused by the system. Memory = that * is available but used for reclaimable caches should NOT be reported= as * free. This value is expressed in kB. */ - VIR_DOMAIN_MEMORY_STAT_UNUSED =3D 4, =20 + VIR_DOMAIN_MEMORY_STAT_AVAILABLE =3D 5, /* * The total amount of usable memory as seen by the domain. This value * may be less than the amount of memory assigned to the domain if a * balloon driver is in use or if the guest OS does not initialize all * assigned pages. This value is expressed in kB. */ - VIR_DOMAIN_MEMORY_STAT_AVAILABLE =3D 5, =20 - /* Current balloon value (in KB). */ VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON =3D 6, + /* Current balloon value (in KB). */ =20 + VIR_DOMAIN_MEMORY_STAT_RSS =3D 7, /* Resident Set Size of the process running the domain. This value * is in kB */ - VIR_DOMAIN_MEMORY_STAT_RSS =3D 7, =20 + VIR_DOMAIN_MEMORY_STAT_USABLE =3D 8, /* * How much the balloon can be inflated without pushing the guest syst= em * to swap, corresponds to 'Available' in /proc/meminfo */ - VIR_DOMAIN_MEMORY_STAT_USABLE =3D 8, =20 - /* Timestamp of the last update of statistics, in seconds. */ VIR_DOMAIN_MEMORY_STAT_LAST_UPDATE =3D 9, + /* Timestamp of the last update of statistics, in seconds. */ =20 + VIR_DOMAIN_MEMORY_STAT_NR =3D 10, /* * The number of statistics supported by this version of the interface. * To add new statistics, add them to the enum and increase this value. */ - VIR_DOMAIN_MEMORY_STAT_NR =3D 10, =20 # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_MEMORY_STAT_LAST =3D VIR_DOMAIN_MEMORY_STAT_NR @@ -683,22 +683,23 @@ typedef enum { =20 /* Domain migration flags. */ typedef enum { + VIR_MIGRATE_LIVE =3D (1 << 0), /* Do not pause the domain during migration. The domain's memory will * be transferred to the destination host while the domain is running. * The migration may never converge if the domain is changing its memo= ry * faster then it can be transferred. The domain can be manually paused * anytime during migration using virDomainSuspend. */ - VIR_MIGRATE_LIVE =3D (1 << 0), =20 + VIR_MIGRATE_PEER2PEER =3D (1 << 1), /* Tell the source libvirtd to connect directly to the destination hos= t. * Without this flag the client (e.g., virsh) connects to both hosts a= nd * controls the migration process. In peer-to-peer mode, the source * libvirtd controls the migration by calling the destination daemon * directly. */ - VIR_MIGRATE_PEER2PEER =3D (1 << 1), =20 + VIR_MIGRATE_TUNNELLED =3D (1 << 2), /* Tunnel migration data over libvirtd connection. Without this flag t= he * source hypervisor sends migration data directly to the destination * hypervisor. This flag can only be used when VIR_MIGRATE_PEER2PEER is @@ -707,26 +708,26 @@ typedef enum { * Note the less-common spelling that we're stuck with: * VIR_MIGRATE_TUNNELLED should be VIR_MIGRATE_TUNNELED. */ - VIR_MIGRATE_TUNNELLED =3D (1 << 2), =20 + VIR_MIGRATE_PERSIST_DEST =3D (1 << 3), /* Define the domain as persistent on the destination host after succe= ssful * migration. If the domain was persistent on the source host and * VIR_MIGRATE_UNDEFINE_SOURCE is not used, it will end up persistent = on * both hosts. */ - VIR_MIGRATE_PERSIST_DEST =3D (1 << 3), =20 + VIR_MIGRATE_UNDEFINE_SOURCE =3D (1 << 4), /* Undefine the domain on the source host once migration successfully * finishes. */ - VIR_MIGRATE_UNDEFINE_SOURCE =3D (1 << 4), =20 + VIR_MIGRATE_PAUSED =3D (1 << 5), /* Leave the domain suspended on the destination host. virDomainResume= (on * the virDomainPtr returned by the migration API) has to be called * explicitly to resume domain's virtual CPUs. */ - VIR_MIGRATE_PAUSED =3D (1 << 5), =20 + VIR_MIGRATE_NON_SHARED_DISK =3D (1 << 6), /* Migrate full disk images in addition to domain's memory. By default * only non-shared non-readonly disk images are transferred. The * VIR_MIGRATE_PARAM_MIGRATE_DISKS parameter can be used to specify wh= ich @@ -734,8 +735,8 @@ typedef enum { * * This flag and VIR_MIGRATE_NON_SHARED_INC are mutually exclusive. */ - VIR_MIGRATE_NON_SHARED_DISK =3D (1 << 6), =20 + VIR_MIGRATE_NON_SHARED_INC =3D (1 << 7), /* Migrate disk images in addition to domain's memory. This is similar= to * VIR_MIGRATE_NON_SHARED_DISK, but only the top level of each disk's * backing chain is copied. That is, the rest of the backing chain is @@ -744,15 +745,15 @@ typedef enum { * * This flag and VIR_MIGRATE_NON_SHARED_DISK are mutually exclusive. */ - VIR_MIGRATE_NON_SHARED_INC =3D (1 << 7), =20 + VIR_MIGRATE_CHANGE_PROTECTION =3D (1 << 8), /* Protect against domain configuration changes during the migration * process. This flag is used automatically when both sides support it. * Explicitly setting this flag will cause migration to fail if either= the * source or the destination does not support it. */ - VIR_MIGRATE_CHANGE_PROTECTION =3D (1 << 8), =20 + VIR_MIGRATE_UNSAFE =3D (1 << 9), /* Force migration even if it is considered unsafe. In some cases libv= irt * may refuse to migrate the domain because doing so may lead to poten= tial * problems such as data corruption, and thus the migration is conside= red @@ -761,8 +762,8 @@ typedef enum { * is unsafe unless the disk images are stored on coherent clustered * filesystem, such as GFS2 or GPFS. */ - VIR_MIGRATE_UNSAFE =3D (1 << 9), =20 + VIR_MIGRATE_OFFLINE =3D (1 << 10), /* Migrate a domain definition without starting the domain on the * destination and without stopping it on the source host. Offline * migration requires VIR_MIGRATE_PERSIST_DEST to be set. @@ -770,28 +771,28 @@ typedef enum { * Offline migration may not copy disk storage or any other file based * storage (such as UEFI variables). */ - VIR_MIGRATE_OFFLINE =3D (1 << 10), =20 + VIR_MIGRATE_COMPRESSED =3D (1 << 11), /* Compress migration data. The compression methods can be specified u= sing * VIR_MIGRATE_PARAM_COMPRESSION. A hypervisor default method will be = used * if this parameter is omitted. Individual compression methods can be * tuned via their specific VIR_MIGRATE_PARAM_COMPRESSION_* parameters. */ - VIR_MIGRATE_COMPRESSED =3D (1 << 11), =20 + VIR_MIGRATE_ABORT_ON_ERROR =3D (1 << 12), /* Cancel migration if a soft error (such as I/O error) happens during * migration. */ - VIR_MIGRATE_ABORT_ON_ERROR =3D (1 << 12), =20 + VIR_MIGRATE_AUTO_CONVERGE =3D (1 << 13), /* Enable algorithms that ensure a live migration will eventually conv= erge. * This usually means the domain will be slowed down to make sure it d= oes * not change its memory faster than a hypervisor can transfer the cha= nged * memory to the destination host. VIR_MIGRATE_PARAM_AUTO_CONVERGE_* * parameters can be used to tune the algorithm. */ - VIR_MIGRATE_AUTO_CONVERGE =3D (1 << 13), =20 + VIR_MIGRATE_RDMA_PIN_ALL =3D (1 << 14), /* This flag can be used with RDMA migration (i.e., when * VIR_MIGRATE_PARAM_URI starts with "rdma://") to tell the hypervisor * to pin all domain's memory at once before migration starts rather t= hen @@ -807,21 +808,20 @@ typedef enum { * domain and the host itself since the host's kernel may run out of * memory. */ - VIR_MIGRATE_RDMA_PIN_ALL =3D (1 << 14), =20 + VIR_MIGRATE_POSTCOPY =3D (1 << 15), /* Setting the VIR_MIGRATE_POSTCOPY flag tells libvirt to enable post-= copy * migration. However, the migration will start normally and * virDomainMigrateStartPostCopy needs to be called to switch it into = the * post-copy mode. See virDomainMigrateStartPostCopy for more details. */ - VIR_MIGRATE_POSTCOPY =3D (1 << 15), =20 + VIR_MIGRATE_TLS =3D (1 << 16), /* Setting the VIR_MIGRATE_TLS flag will cause the migration to attempt * to use the TLS environment configured by the hypervisor in order to * perform the migration. If incorrectly configured on either source or * destination, the migration will fail. */ - VIR_MIGRATE_TLS =3D (1 << 16), =20 } virDomainMigrateFlags; =20 @@ -2986,16 +2986,16 @@ typedef enum { * Details on the cause of a 'shutdown' lifecycle event */ typedef enum { - /* Guest finished shutdown sequence */ VIR_DOMAIN_EVENT_SHUTDOWN_FINISHED =3D 0, + /* Guest finished shutdown sequence */ =20 + VIR_DOMAIN_EVENT_SHUTDOWN_GUEST =3D 1, /* Domain finished shutting down after request from the guest itself * (e.g. hardware-specific action) */ - VIR_DOMAIN_EVENT_SHUTDOWN_GUEST =3D 1, =20 + VIR_DOMAIN_EVENT_SHUTDOWN_HOST =3D 2, /* Domain finished shutting down after request from the host (e.g. kil= led by * a signal) */ - VIR_DOMAIN_EVENT_SHUTDOWN_HOST =3D 2, =20 # ifdef VIR_ENUM_SENTINELS VIR_DOMAIN_EVENT_SHUTDOWN_LAST --=20 2.13.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list