From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3AF90C35FF3 for ; Fri, 21 Mar 2025 06:34:02 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 9F8D1280002; Fri, 21 Mar 2025 02:34:00 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 9A6ED280001; Fri, 21 Mar 2025 02:34:00 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 8705E280002; Fri, 21 Mar 2025 02:34:00 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 69363280001 for ; Fri, 21 Mar 2025 02:34:00 -0400 (EDT) Received: from smtpin30.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id DCAB0578D2 for ; Fri, 21 Mar 2025 06:34:01 +0000 (UTC) X-FDA: 83244593082.30.82185F0 Received: from mail-pj1-f73.google.com (mail-pj1-f73.google.com [209.85.216.73]) by imf17.hostedemail.com (Postfix) with ESMTP id 1603540004 for ; Fri, 21 Mar 2025 06:33:59 +0000 (UTC) Authentication-Results: imf17.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=FbtXVF3p; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf17.hostedemail.com: domain of 3VgjdZwoKCCE9E7KDVR7KIDLLDIB.9LJIFKRU-JJHS79H.LOD@flex--changyuanl.bounces.google.com designates 209.85.216.73 as permitted sender) smtp.mailfrom=3VgjdZwoKCCE9E7KDVR7KIDLLDIB.9LJIFKRU-JJHS79H.LOD@flex--changyuanl.bounces.google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1742538840; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=2vXAyj+GHzS7wqAccTE1NbTCMIzG8yR1/7SBWPdH7m8=; b=6W5qGtwPc77y3ONysSsqC0+P+mu9yNXYTry5xTjF8Dc/MOk1tX9mZmP5DxlbuqDzLLd9V6 x8k8OvsMboXlfvgIA9N3rHOOrOcgBPPKozlenUUyMJgLCgDot/ytF52BH1u27TJhsXt7j2 SXsLg/9gcuZk9q+S5DqGAB/3GsdLySA= ARC-Authentication-Results: i=1; imf17.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=FbtXVF3p; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf17.hostedemail.com: domain of 3VgjdZwoKCCE9E7KDVR7KIDLLDIB.9LJIFKRU-JJHS79H.LOD@flex--changyuanl.bounces.google.com designates 209.85.216.73 as permitted sender) smtp.mailfrom=3VgjdZwoKCCE9E7KDVR7KIDLLDIB.9LJIFKRU-JJHS79H.LOD@flex--changyuanl.bounces.google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1742538840; a=rsa-sha256; cv=none; b=ed25sejLMwyErE11dUKE0lVNW0Is7UWB2iOg0BznfKjWFmbmEwNM9+1HF98vTPUL9PWdxL qciXMJ1abhN05ClcDnAW/SumsiEWCGAcDxXZmR1SLnSPW1kTefB5uL3WoA8tRo5ccBv0RL 7CaadRNvgOY/ko/oCWsqHcEmyRa7Gsw= Received: by mail-pj1-f73.google.com with SMTP id 98e67ed59e1d1-2ff5296726fso4549356a91.0 for ; Thu, 20 Mar 2025 23:33:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1742538839; x=1743143639; darn=kvack.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=2vXAyj+GHzS7wqAccTE1NbTCMIzG8yR1/7SBWPdH7m8=; b=FbtXVF3pjIFY0VtLaPT/MHcL5f4tlj/m4z3KZcrT2hj4CkMOL7dgK/PBZIeNVI+OGJ 91JNHngWEpNUg9eVyHoEhvodhMs3dhane+mhtwJVrCbQXU+rzU0v3PPLrAF0FtCIIjBr j9wckvGl86uyHaiJeDOQ74QLOmz+MXulkEBI2eX6/2DPcgDTVNLII1BgGQVGJPryEUQJ 3XsUUtzI2Kun9MNlY5PTWSEEgiigPL56qEwQP1pc5kFkIDwVQFHIifLgR9bSTXCgHWuI 3TsaYlo89RwzCyDxHmwSbsZk8RTNCJRTAjcDvC8yWL1fN+mtD92wIqDIVi48OAlYADc7 eQEA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742538839; x=1743143639; h=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; bh=2vXAyj+GHzS7wqAccTE1NbTCMIzG8yR1/7SBWPdH7m8=; b=ToBhW1QNgO/l2+UqFQc57QYyLOs6u5WSgBhfkf2Y+svhImnFEb6A7ZYCtDBueSJXvs 3k917bSRXMFr3BU2pK0B3uHAaJq4mb8xGZ4zxQlfWwgOQVlNO1Olra3g/S/xrSNqu+4d 8XKT7Vjsr796rU0A0CVZRrqrFX3H97Ut/6foHzpbip6Ikh0tJUI2A2oqnrumpm1DZ6RI 2Ox1IXoN2vixr9Py0brRKFvWyBDs0zETWGrcIwvjVkgcNgXdIgpFF+Dwp5m0KM2/4I/2 pniC1z3KShCkyw/QuMpU0o6GVAiThMqnqRImsNYkxgErHNo0ec36q85/ykhe1KJ04gxs 5XUw== X-Forwarded-Encrypted: i=1; AJvYcCWwZGqLWwaF1ZmEhoPzxdaglmEpV5MZP1C001j5vt4FrAOsBNZS8EyamEPJUIsYZEtRToPYkCmzqA==@kvack.org X-Gm-Message-State: AOJu0YyyKRtDdaT+8Pq95QTKVQbvMwHFhfmLswhzffE/Bf4mpRSL1cXp 1QXijAhsfbIrW9hNGFiRDS4lR+HNMefgqy4dViJ062cChjp31J2qQcg+yDL8Bo3paOkKNlrwarE +QhDp0ybs5L9tUEkUVQ== X-Google-Smtp-Source: AGHT+IHzfqXaz88vnwbh1bU3QQ0eg9cO7MjTqz+i1yp3jt6YPQs5uqsY4Klq/6OgfyRjy5OLLCoj7DrCd0HOjDbw X-Received: from pjbsk8.prod.google.com ([2002:a17:90b:2dc8:b0:2fc:2ee0:d38a]) (user=changyuanl job=prod-delivery.src-stubby-dispatcher) by 2002:a17:90b:1848:b0:2ea:bf1c:1e3a with SMTP id 98e67ed59e1d1-3030fe9e646mr4063011a91.12.1742538838726; Thu, 20 Mar 2025 23:33:58 -0700 (PDT) Date: Thu, 20 Mar 2025 23:33:56 -0700 In-Reply-To: <87wmcj69sg.fsf@trenco.lwn.net> Mime-Version: 1.0 References: <87wmcj69sg.fsf@trenco.lwn.net> X-Mailer: git-send-email 2.49.0.395.g12beb8f557-goog Message-ID: <20250321063356.381646-1-changyuanl@google.com> Subject: Re: [PATCH v5 16/16] Documentation: add documentation for KHO From: Changyuan Lyu To: corbet@lwn.net Cc: akpm@linux-foundation.org, anthony.yznaga@oracle.com, arnd@arndb.de, ashish.kalra@amd.com, benh@kernel.crashing.org, bp@alien8.de, catalin.marinas@arm.com, changyuanl@google.com, dave.hansen@linux.intel.com, devicetree@vger.kernel.org, dwmw2@infradead.org, ebiederm@xmission.com, graf@amazon.com, hpa@zytor.com, jgowans@amazon.com, kexec@lists.infradead.org, krzk@kernel.org, linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, luto@kernel.org, mark.rutland@arm.com, mingo@redhat.com, pasha.tatashin@soleen.com, pbonzini@redhat.com, peterz@infradead.org, ptyadav@amazon.de, robh+dt@kernel.org, robh@kernel.org, rostedt@goodmis.org, rppt@kernel.org, saravanak@google.com, skinsburskii@linux.microsoft.com, tglx@linutronix.de, thomas.lendacky@amd.com, will@kernel.org, x86@kernel.org Content-Type: text/plain; charset="UTF-8" X-Rspamd-Server: rspam11 X-Rspamd-Queue-Id: 1603540004 X-Stat-Signature: w6ernpxuunrwijwqt19nyxquitmawz3g X-Rspam-User: X-HE-Tag: 1742538839-806369 X-HE-Meta: U2FsdGVkX1+iwC/OuK6GKdLma+4ZKlBG7eMJ2GmGXN8cQWEK1R4P8TjyILOp3ZS3eYO4Weq1SCUK9dSMoTboKq9fvkADvTQuyO6eW8CqEwGR7zAY1YhsWHEL5VCghT0eZJyW4+sGBrzLaYprCbqo1xcTlfnhYU30isPE9eW0DUATJqut5hzE3q3U7V/uzTZeYsI45u51d02qHwar2sIY9WvICKGfUNAD7YErBYbFdDLJVQs9GnsvRrlNH13lrVF+6LUTZfMpQhy1WXjitfELAYH5kl4hTdMD8y6d/Nl2QFrr8ROfooyls93OtJU6MLwCSta6RlP1ipAmccFHyQhh0oH8Dw/6PGEkldtvBkD0Qm7BBAajEIUgO2wqnvGq4sA5a+wQLt19D5fBxzs+8SI9e0pFyTEeLRz8l/eScfY1Xr6mLk5ZG8ZEsKcurlf2cQO5WkrHmOnwAvdaH+uNzKXQQH9DfUz62k2OKhlBjA4tuHwhv8ZxWiyTQVJUKNP9m7F+ClkPDXOhDyu0/+e2bJU3jo07LI9AlWepro00jU8TKIhMYT21CsVeYdGaxiMoBlvuX7tDzMO7ZqtuQXXbi+5Z7Cu6tybGB5WgToM8GYcX3rgvuTenrH1Vts4kTK+OVZGsf1VOvGKvbO4Nuy4CeRMRH8vnYlnM67phbAVLkTB02fNE89ZDNO8L3BOnUiaNtNaFR7sGSj5+TKbptuFZBfuzYi0x7ZGlcAq2A8aT71Phzpn3zdVftaWvuPT4dJ3H7nhSdc3PQihgFWbLBo2MqyzyC0tZHPk7CNNMxXTr7/hJ3We9NTA9GLHZy4+50Ql4h5/EIKGYpZYfCw9T60JCcJ6URvqV412wbN0hXVso4uvt/D7BuR+DiBNNFQ5LM9vISad/WUU8Hoo67PO1Bga+fIWEI2PoGHZGR/DhXfvzc3EIVPJGeBk8K6NCte/lZjBDwdllzTvmOlXUFf6OWQ9FG3t nc32PYOg zLUJXwH7p7rWK2gzUWxJ08ts8fNNQs1RlrMUDjd9jJSP8uzREV0ImuxgrDU0LITUiJIutd5qTc51avCVkDabr95D1XfgDxUsBIolnThreu12xjQBSkNnvXF3kEb3H2+0tbDopRHNnEezX+/IVl0iRqm4RtHWjNNN+daYt0PWsaW7ACkDIxfYYOeDbVrf/k4ZQ1nsg/Yq1EKyxEDnJJlwGI0zX3x38ZOFb0siMFBWG4o7hEgNryAxX94QBVHDdTv3dEie7enKoPTt2TVpFNBsZODK/eMvBBPBnQJrpYyzDshFDGK8TSHLwKdOJ0EzTQArwuHsNCp55B0KyNBH6xRQJriZt9NL1ceqkVlnpLkiGInppPOkQnNN+rC3lm73viAKS59L0x3Ii5RyPZJZ+XwJp1WIiz9jMTmy79T+3sRwvUkLVp7LsqNr7t79DgF+VWZ/ua8Lk75+gA1hDqd7sKBwKRod09zVKG8qpl9p4JW9pRZ9X/Mmi/1WTXjNAiqpy771njch+PwFjQLM1Sg/Yx/cse9Ty510pwUu/8egJxrAHtl/5TNIoKkf+Jdw+KP/VBW/EySlbgO54fFxVlsbAH4DMks2j+3MpaKLj5dgbV3gNtvhUjQ7E1dXuvUZGu93o5y0/Te1Yn2VyJ7+GFfeVqpGF8JCM8n7znl9+qgtyUjevjRg0pa5SOx0Cqm/muX5B/VBzzJCDkv4wLxo73kYmIhkqJ7DhwYudgb5QkBLgRxgA83liXggLKPAPePiJ1KNoh/G2/A+X X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: Hi Jonathan, On Thu, Mar 20, 2025 at 08:45:03 -0600, Jonathan Corbet wrote: > Changyuan Lyu writes: > > > From: Alexander Graf > > > > With KHO in place, let's add documentation that describes what it is and > > how to use it. > > > > Signed-off-by: Alexander Graf > > Co-developed-by: Mike Rapoport (Microsoft) > > Signed-off-by: Mike Rapoport (Microsoft) > > Co-developed-by: Changyuan Lyu > > Signed-off-by: Changyuan Lyu > > --- > > .../admin-guide/kernel-parameters.txt | 25 ++++ > > Documentation/kho/concepts.rst | 70 +++++++++++ > > Documentation/kho/fdt.rst | 62 +++++++++ > > Documentation/kho/index.rst | 14 +++ > > Documentation/kho/usage.rst | 118 ++++++++++++++++++ > > Documentation/subsystem-apis.rst | 1 + > > MAINTAINERS | 1 + > > 7 files changed, 291 insertions(+) > > create mode 100644 Documentation/kho/concepts.rst > > create mode 100644 Documentation/kho/fdt.rst > > create mode 100644 Documentation/kho/index.rst > > create mode 100644 Documentation/kho/usage.rst > > I will ask again: please let's not create another top-level docs > directory for this...? It looks like it belongs in the admin guide to > me. Thanks for review the patch! Sure I will move usage.rst to Documentation/admin-guide in the next version. However, I think concepts.rst and fdt.rst are not not end-user oriented, but for kernel developers of other subsystems to use KHO API (I also plan to include the kernel-doc generated from kernel/kexec_handover.c and include/linux/kexec_handover.h here in the next version). Should Documentation/core-api be a better choice? Best, Changyuan