From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wm1-f72.google.com (mail-wm1-f72.google.com [209.85.128.72]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B956D3DC878 for ; Mon, 10 Aug 2026 13:21:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.72 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786368087; cv=none; b=Fi+Ruf99KJYz74GDIuIUitj9qtYe1EZ2OjOQZ30TmfkcvsDwprK/td+eZm0SEemo1vfTi+S08MqP+nh8CzENIJV9Y4l086fzMg/gGrHtqc18pSHI+0m+xvvH2uvAHwGf1lbE03Hx5OuED8wbSlCqsJvSb1h0jTuhGTYfFbSRsAs= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786368087; c=relaxed/simple; bh=Jritruhw88V157bsaVjUyVKBcWQHYkBHQchXkcJBv5s=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=R/RGq3+3biwG+q9xFImM2XRccixQs10pUsZFFEnDQ2dxeEkyAYsdsZTm1Y817jVaNdhBvNXeVTZ37x6OJBrqTeTxo2NR18b0u409xvxPWTsLumzqgmn5VtnhH5rZZz5XBK0fN8gkX9sUWbiNsaE4TaUQhd96x8+ImfV9K8XajrA= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--tarunsahu.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=CbR/wRsT; arc=none smtp.client-ip=209.85.128.72 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--tarunsahu.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="CbR/wRsT" Received: by mail-wm1-f72.google.com with SMTP id 5b1f17b1804b1-496b6f97676so18841055e9.2 for ; Mon, 10 Aug 2026 06:21:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1786368084; x=1786972884; darn=lists.linux.dev; h=content-transfer-encoding:content-type:cc:to:from:subject :message-id:references:mime-version:in-reply-to:date:from:to:cc :subject:date:message-id:reply-to:content-type; bh=NUXsdBwMwxI/nd8pDWWxjP+P4ja3jy+HCgssAFJhmgg=; b=CbR/wRsT5od2T8ZzVx6vT+CvheVXxQxC7tuL1N/aYTl6eYPFe+8J9VPDnIiET2CGuk jcK0zxTUynLI9vv9uGObHmxaoMGV3gh1Zem0QCjsAqwcJP8Gkng47ZEtYVI+hGlgDOaf 8NCU6HQbMSytbIHRRBrxukvH6EA2LCSsVW5RJbw43fILkNzswzk9CLaV19hNopfmLiFU 6fD6tjURuXKtCerINrYxcg+gh+ATpxSFbv0Lr3lC7d8UtXvmyBPkjFplxxR6sUmfQAtw 7oz+FcWATk+Kjn7OOKLcoZq5dprGH6XYmefO2ep5EUJegxW66SbN3BXW3GAiskUi1XQB bSMw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1786368084; x=1786972884; h=content-transfer-encoding:content-type:cc:to:from:subject :message-id:references:mime-version:in-reply-to:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to :content-type; bh=NUXsdBwMwxI/nd8pDWWxjP+P4ja3jy+HCgssAFJhmgg=; b=Mf3TlBa/a2mK0ffVRF6r7V5ESlKkhN9Gqw8EaPUhCRD+5kWEQld46mCMh+H57sr38V Nk3xPmvXdXCTrdvxVZ0f/lqwOdwtx4KKibKyAFDYu65c2pfzcMIlQWtrnm9Y/3HjPFtQ +KmoGFWxlPhZ9p/eBPD282skSi7o1LwWJ2RYJ4A0pnCfoG4ewIT3+OLE01AmJf/te5jI SK7AQaDyZd9D5VACSa8XdnOlZwxd5AASVIzzntg+/CprnQfkaXqVKf8Lwzfp7CjkR4Y8 DXNznx1rx09jGKZa9jkE6WCFU/6RhVJ0Idjnrq4S5yaiYQ4pKdY+vwwNX9Nry6+1SsaH Ev8g== X-Gm-Message-State: AOJu0YzMbV+1NxV0PmB4+BIJDl1R1qKRFNA1Vgw+bgEAHZJMql4cZri4 Cm/kAke7MaFrgPgpCIDfE7T+UNf5NMDWbD3sdwcQl0qaCCDKBqKn8T5+AOHIZ40guH4PO8qvWST JN3SFB1CYhQF92jts9g== X-Received: from wrwl10.prod.google.com ([2002:a5d:674a:0:b0:47d:fb5d:6130]) (user=tarunsahu job=prod-delivery.src-stubby-dispatcher) by 2002:a05:600c:4715:b0:493:cefc:d113 with SMTP id 5b1f17b1804b1-4996195884bmr227828785e9.5.1786368083378; Mon, 10 Aug 2026 06:21:23 -0700 (PDT) Date: Mon, 10 Aug 2026 13:21:22 +0000 In-Reply-To: <20260728122128.D0E831F000E9@smtp.kernel.org> Precedence: bulk X-Mailing-List: kvmarm@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20260728121138.1103610-1-tarunsahu@google.com> <20260728121138.1103610-10-tarunsahu@google.com> <20260728122128.D0E831F000E9@smtp.kernel.org> Message-ID: <9huzy0ee6rhp.fsf@tarunix.c.googlers.com> Subject: Re: [PATCH v4 09/11] docs: liveupdate: Add documentation for VM and guest_memfd preservation From: tarunsahu@google.com To: sashiko-reviews@lists.linux.dev Cc: kvmarm@lists.linux.dev, Marc Zyngier , Oliver Upton , kvm@vger.kernel.org Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable sashiko-bot@kernel.org writes: > Thank you for your contribution! Sashiko AI review found 1 potential issu= e(s) to consider: > - [Low] Mismatched kernel-doc section titles cause Sphinx build warnings = and missing documentation. > -- > > --- Patch [9]: [PATCH v4 09/11] docs: liveupdate: Add documentation for V= M and guest_memfd preservation --- > commit a930d2f58a9edc06bdcfd10fb383e97d7fe3996c > Author: Tarun Sahu > > docs: liveupdate: Add documentation for VM and guest_memfd preservation > =20 > Add Documentation/liveupdate/vmm.rst detailing VMM requirements, scope, > ordering constraints, and kernel-doc inclusions for KVM VM and > guest_memfd preservation via Live Update Orchestrator (LUO). > >> diff --git a/Documentation/liveupdate/vmm.rst b/Documentation/liveupdate= /vmm.rst >> new file mode 100644 >> index 0000000000000..b8e8fb2b63c21 >> --- /dev/null >> +++ b/Documentation/liveupdate/vmm.rst >> @@ -0,0 +1,107 @@ >> +.. SPDX-License-Identifier: GPL-2.0-or-later >> + >> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D >> +VM & Guest_Memfd Preservation >> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D >> + >> +.. kernel-doc:: virt/kvm/kvm_luo.c >> + :doc: KVM VM Preservation via LUO >> + >> +.. kernel-doc:: virt/kvm/guest_memfd_luo.c >> + :doc: Guest_Memfd Preservation via LUO > > [Severity: Low] > Does this section title exactly match the DOC: title in > virt/kvm/guest_memfd_luo.c? > > If the source file uses "Guestmemfd Preservation via LUO" without the > underscore, this directive will fail to find the documentation and genera= te a > Sphinx build warning. I will correct it. Good find! > > [ ... ] > >> +VM & Guest_Memfd Preservation ABI >> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >> + >> +.. kernel-doc:: include/linux/kho/abi/kvm.h >> + :doc: DOC: guest_memfd Live Update ABI > > [Severity: Low] > Does this section title match the actual title in include/linux/kho/abi/k= vm.h? > > If the source file uses "KVM and guest_memfd Live Update ABI", this misma= tch > will cause empty sections in the generated documentation. > > Also, should the literal "DOC: " prefix be omitted here? The directive > typically only expects the text that follows the prefix. > >> + >> +.. kernel-doc:: include/linux/kho/abi/kvm.h >> + :internal: >> + >> +See Also > > --=20 > Sashiko AI review =C2=B7 https://sashiko.dev/#/patchset/20260728121138.11= 03610-1-tarunsahu@google.com?part=3D9