From nobody Tue Dec 16 16:35:15 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A7C42C10DCE for ; Fri, 1 Dec 2023 13:11:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1378942AbjLANKz (ORCPT ); Fri, 1 Dec 2023 08:10:55 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57020 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1378926AbjLANKv (ORCPT ); Fri, 1 Dec 2023 08:10:51 -0500 Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2323A1B3; Fri, 1 Dec 2023 05:10:58 -0800 (PST) Received: by mail.gandi.net (Postfix) with ESMTPSA id 7B5B61C0003; Fri, 1 Dec 2023 13:10:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1701436256; h=from:from: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:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=9FeCe/iJRh9PXhO+JUUpdycmH2P44LnefnJNVIv/kuk=; b=AJqYPYmBu/vDoqeI9rBu4CN8GosfUMAM2vgRkj1+t+8ObxZRYocEBYtYfbqbdzcnWL30W0 tuGpzJtwIojPVVL8qILibvkexgcKaY7wB8B8oA41718xyiTvDJiPy8SQplMAiYG052ymRg itl6SdNjjXS3RTFldZfonOz6aiFIfA5xGQV2bBHnNX0BD49SRqw7E9jSLlFGbluhECx+6Y //s5Iqw1+gdCR8Q7C9wa4Mp+qWNgM7FHbUoHQLrtf5t2L4oTN4vQiFyCji5oSZasTUQfbX ZWDNQqBXlR0bgjXlG9QFmJDjk7ZuQVC6ydCPEmJdzK2y06x5aHabjC0L/aRLkg== From: Luca Ceresoli Date: Fri, 01 Dec 2023 14:10:42 +0100 Subject: [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20231201-nvmem-docs-kerneldoc-v1-1-3e8f2b706ce6@bootlin.com> References: <20231201-nvmem-docs-kerneldoc-v1-0-3e8f2b706ce6@bootlin.com> In-Reply-To: <20231201-nvmem-docs-kerneldoc-v1-0-3e8f2b706ce6@bootlin.com> To: Jonathan Corbet Cc: Thomas Petazzoni , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Luca Ceresoli X-Mailer: b4 0.12.4 X-GND-Sasl: luca.ceresoli@bootlin.com Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This is useful on its own, and it also enables hyperlink generation for functions mentioned in ReST documentation. Signed-off-by: Luca Ceresoli Reviewed-by: Bagas Sanjaya --- Documentation/driver-api/nvmem.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/= nvmem.rst index de221e91c8e3..d5655b95c0f4 100644 --- a/Documentation/driver-api/nvmem.rst +++ b/Documentation/driver-api/nvmem.rst @@ -200,3 +200,9 @@ and let you add cells dynamically. Another use case for layouts is the post processing of cells. With layouts, it is possible to associate a custom post processing hook to a cell. It even possible to add this hook to cells not created by the layout itself. + +9. Internal kernel API +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. kernel-doc:: drivers/nvmem/core.c + :export: --=20 2.34.1 From nobody Tue Dec 16 16:35:15 2025 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 61B0BC4167B for ; Fri, 1 Dec 2023 13:11:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1378949AbjLANK5 (ORCPT ); Fri, 1 Dec 2023 08:10:57 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52338 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1378931AbjLANKw (ORCPT ); Fri, 1 Dec 2023 08:10:52 -0500 Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [IPv6:2001:4b98:dc4:8::225]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C1F7B10E2; Fri, 1 Dec 2023 05:10:58 -0800 (PST) Received: by mail.gandi.net (Postfix) with ESMTPSA id 11E5B1C0009; Fri, 1 Dec 2023 13:10:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1701436257; h=from:from: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:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=y6S+SeJyJSSx13s7SoQDTcyNB66xoOdwpxFSTRy/oEw=; b=gpz4Lq9mexHB7eDRII3Y6WaRbFaseHxKbbMWZeG4Ek0q2zRg6Mk4FdfLHoYKRsUCOKWgAU t6xERSduhW/g+qqZ/3nXnD1D+xuR3U7WzB6YiNjvywwbCIst5FeL4HQSpNQXGY9LFzGJxW eCPG9RunxECaIXDQtuh9VsJrPcGMpeBy/7QRfcFkiHjS33yAehHj8KDz6w/JN3/sr9voPl eWjQJdKaLq0f+DWJV2SeH8ym9uGywwYjapDKboD3N7T7IDj3GisHKgrPqEl1fHh5WZo8RJ L7NkjbPMyz18yXH7Dte2uGJAZfaVoZJpkMj69I9fjk/f/3BvKPhWec2+9EzXPQ== From: Luca Ceresoli Date: Fri, 01 Dec 2023 14:10:43 +0100 Subject: [PATCH 2/2] docs: nvmem: remove function parameters (fixes hyperlink generation) MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20231201-nvmem-docs-kerneldoc-v1-2-3e8f2b706ce6@bootlin.com> References: <20231201-nvmem-docs-kerneldoc-v1-0-3e8f2b706ce6@bootlin.com> In-Reply-To: <20231201-nvmem-docs-kerneldoc-v1-0-3e8f2b706ce6@bootlin.com> To: Jonathan Corbet Cc: Thomas Petazzoni , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Luca Ceresoli X-Mailer: b4 0.12.4 X-GND-Sasl: luca.ceresoli@bootlin.com Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Adding a parameter is not particularly useful here, and it is definitely not done elsewhere. It also prevents the generation of a hyperlink to the kernel-doc documentation. Removing the parameter to enable hyperlinks and make the style coherent. Signed-off-by: Luca Ceresoli --- Documentation/driver-api/nvmem.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/= nvmem.rst index d5655b95c0f4..5d9500d21ecc 100644 --- a/Documentation/driver-api/nvmem.rst +++ b/Documentation/driver-api/nvmem.rst @@ -41,7 +41,7 @@ A NVMEM provider can register with NVMEM core by supplyin= g relevant nvmem configuration to nvmem_register(), on success core would return a va= lid nvmem_device pointer. =20 -nvmem_unregister(nvmem) is used to unregister a previously registered prov= ider. +nvmem_unregister() is used to unregister a previously registered provider. =20 For example, a simple nvram case:: =20 --=20 2.34.1