From nobody Mon Feb 9 04:46:02 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1595510706; cv=none; d=zohomail.com; s=zohoarc; b=abX282SDPU19Wq5IRUimR2CyFnDinC6yjcGxUJNqvSydYbCceDJP26DPKg7lVFKcZNRg2M0lvysMvzZtivGzeegbxpoZUt3buFGnaTIDOsrRh5uyagne+QjQPjB35zl5mQ8GfKSYqOJTHIWmX3izXv3/AvLt4OxvtMYMny8AQcQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1595510706; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=0j9l4F/Oo6R/VurXKfzzJulOMgkvM8Ik+RSKgQibbps=; b=WOJnKm57tv33rjTtLDF9sybD+/ZVU3VN2MDbXR9QbxYEYU+W9D8UTVH48zYjlOGXrwGzgxBVzT8QXGpOGMVUiAUxGkcFO6IrTpu+30AMXbk1xAP62ZekEyK6+jZyUrv9UvuqXrnahvMtRW7kd2dq+nB4AGFEwA2Vg+YvEBGHN8g= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1595510706704143.47640165965197; Thu, 23 Jul 2020 06:25:06 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-87-uPot_Es2NgWPRFNZxR-faQ-1; Thu, 23 Jul 2020 09:22:25 -0400 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 mimecast-mx01.redhat.com (Postfix) with ESMTPS id BA8F9800471; Thu, 23 Jul 2020 13:22:16 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 96EC16FEFE; Thu, 23 Jul 2020 13:22:16 +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 6706D1800B71; Thu, 23 Jul 2020 13:22:16 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 06NDMDCE028542 for ; Thu, 23 Jul 2020 09:22:13 -0400 Received: by smtp.corp.redhat.com (Postfix) id B10AB1A91F; Thu, 23 Jul 2020 13:22:13 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.37]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0521F19D7D for ; Thu, 23 Jul 2020 13:22:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1595510705; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=0j9l4F/Oo6R/VurXKfzzJulOMgkvM8Ik+RSKgQibbps=; b=GR4SpLNwRIiH0XgsOYaXho3kCCxmoywuUxaQ1A5ouVanlvXy48s5FUHkGjleDMJAuo5Yyu h5WZHN5VVAG0nqWo4EdSAAXprP0ihBjIYWFAhDizq7i/qXGfzQI4NvR1bHaDpfDLDG/TId ajQPyO6Y7SgRkNtvYA/xk7B/ult0e/I= X-MC-Unique: uPot_Es2NgWPRFNZxR-faQ-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 12/32] docs: formatdomain-devices: Split out Date: Thu, 23 Jul 2020 15:21:17 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-loop: libvir-list@redhat.com 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Start splitting out part of into smaller sections. Signed-off-by: Peter Krempa --- docs/formatdomain-devices-lease.rst | 35 +++++++++++++++++++++++++++ docs/formatdomain-devices.rst | 37 +---------------------------- docs/meson.build | 1 + 3 files changed, 37 insertions(+), 36 deletions(-) create mode 100644 docs/formatdomain-devices-lease.rst diff --git a/docs/formatdomain-devices-lease.rst b/docs/formatdomain-device= s-lease.rst new file mode 100644 index 0000000000..722f9a629f --- /dev/null +++ b/docs/formatdomain-devices-lease.rst @@ -0,0 +1,35 @@ +:anchor:`` + +Device leases +~~~~~~~~~~~~~ + +When using a lock manager, it may be desirable to record device leases aga= inst a +VM. The lock manager will ensure the VM won't start unless the leases can = be +acquired. + +:: + + ... + + ... + + somearea + somekey + + + ... + + ... + +``lockspace`` + This is an arbitrary string, identifying the lockspace within which the= key + is held. Lock managers may impose extra restrictions on the format, or = length + of the lockspace name. +``key`` + This is an arbitrary string, uniquely identifying the lease to be acqui= red. + Lock managers may impose extra restrictions on the format, or length of= the + key. +``target`` + This is the fully qualified path of the file associated with the locksp= ace. + The offset specifies where the lease is stored within the file. If the = lock + manager does not require an offset, just pass 0. diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index e65020330d..d704cbe05b 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -44,42 +44,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3= .9.0` .. include:: formatdomain-devices-address.rst .. include:: formatdomain-devices-virtio.rst .. include:: formatdomain-devices-controller.rst - -:anchor:`` - -Device leases -~~~~~~~~~~~~~ - -When using a lock manager, it may be desirable to record device leases aga= inst a -VM. The lock manager will ensure the VM won't start unless the leases can = be -acquired. - -:: - - ... - - ... - - somearea - somekey - - - ... - - ... - -``lockspace`` - This is an arbitrary string, identifying the lockspace within which the= key - is held. Lock managers may impose extra restrictions on the format, or = length - of the lockspace name. -``key`` - This is an arbitrary string, uniquely identifying the lease to be acqui= red. - Lock managers may impose extra restrictions on the format, or length of= the - key. -``target`` - This is the fully qualified path of the file associated with the locksp= ace. - The offset specifies where the lease is stored within the file. If the = lock - manager does not require an offset, just pass 0. +.. include:: formatdomain-devices-lease.rst :anchor:`` diff --git a/docs/meson.build b/docs/meson.build index fb65cef2e5..0609bfa6a8 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -129,6 +129,7 @@ docs_rst_files =3D [ 'formatdomain-devices-address.rst', 'formatdomain-devices-virtio.rst', 'formatdomain-devices-controller.rst', + 'formatdomain-devices-lease.rst', ] }, { 'name': 'hacking' }, --=20 2.26.2