| Message ID | 20231201-nvmem-docs-kerneldoc-v1-2-3e8f2b706ce6@bootlin.com |
|---|---|
| State | New |
| Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:a59:bcd1:0:b0:403:3b70:6f57 with SMTP id r17csp1106120vqy;
Fri, 1 Dec 2023 05:11:38 -0800 (PST)
X-Google-Smtp-Source:
AGHT+IED4oClTzVPQSUnNlWF/Zfu9vSoktf4F1xC/+bnOTuHwGXsA3ouDn/WBxUwkEHLv5F7vqn2
X-Received: by 2002:a05:6e02:106e:b0:35c:7d64:fa53 with SMTP id
q14-20020a056e02106e00b0035c7d64fa53mr23839295ilj.7.1701436298411;
Fri, 01 Dec 2023 05:11:38 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1701436298; cv=none;
d=google.com; s=arc-20160816;
b=fHEhxUi3Bojh3aTIGWivHjEgMZ9LOWK812MVtD7VZAMzp7r/WrHPr6QQHZnkQClgG5
S0uHX6qQYjuthkd23SYE+KS1Rr+mYdho9C9Zi3PDQVo+BAuCoSpAMOBPGInjhf6iLNmC
wfEpszuKfd1JQemvCxkau5c2qM5G6DbTmPwQN6TXB84rnU42SClxkciNMfx9j5dX77pp
rUpZOJ1c2qmCpvYPxDRrmDCxFE7G6RB5ViWukgGVXCvzyZsKzmqbp1Ha0GA3Zk2DYeS5
suNSCTDiuf4N1UUODKLSzETCJkBTTRcBJr4chhfYuKszA0JehjAf9gEV879TGZFRlAUn
icJw==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=list-id:precedence:cc:to:in-reply-to:references:message-id
:content-transfer-encoding:mime-version:subject:date:from
:dkim-signature;
bh=y6S+SeJyJSSx13s7SoQDTcyNB66xoOdwpxFSTRy/oEw=;
fh=jSu+PksZ5fdVglEtsPNPl/no1B7e+ljor/NCVR2Haiw=;
b=qx4vDDjD7MJYxupOnDkNVZJJoZCB5C5xUWlxB8vBONtIg4xiYSMRsHOXp7zntyWSVH
NAfx0w8hn8UxgVtPzC9GaQJC2q5BnV+5Cq+L37J5fi94Z1UW78slG3fKOVVbP2XRREfS
jrU8vjKawgq4S1xUjrnX0uX2QUZr2+Akfd7lhA4ZkB6UWOP0gvlC0uOaTOte02mkXBvw
wPFf+8f5dqCI3ypdUtskWeat9UjTtLmzH5CongbhtlCPk03y7nq5dRXSk1tmDZUtavp8
mscO2OJZmAAzPdAmuqPkNuoPeq/2Z5asC+PW9qIR8OWcg67qMsSV4LhgWrQLxT5etS9D
StYA==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@bootlin.com header.s=gm1 header.b=gpz4Lq9m;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::3:8 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com
Received: from fry.vger.email (fry.vger.email. [2620:137:e000::3:8])
by mx.google.com with ESMTPS id
k26-20020a63ff1a000000b005c1b311a152si3416648pgi.657.2023.12.01.05.11.27
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 01 Dec 2023 05:11:38 -0800 (PST)
Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::3:8 as permitted sender)
client-ip=2620:137:e000::3:8;
Authentication-Results: mx.google.com;
dkim=pass header.i=@bootlin.com header.s=gm1 header.b=gpz4Lq9m;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::3:8 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com
Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0])
by fry.vger.email (Postfix) with ESMTP id 0E07181C09AE;
Fri, 1 Dec 2023 05:11:25 -0800 (PST)
X-Virus-Status: Clean
X-Virus-Scanned: clamav-milter 0.103.11 at fry.vger.email
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
id S1378945AbjLANK4 (ORCPT <rfc822;ruipengqi7@gmail.com>
+ 99 others); Fri, 1 Dec 2023 08:10:56 -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
<rfc822;linux-kernel@vger.kernel.org>);
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 <luca.ceresoli@bootlin.com>
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: 7bit
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 <corbet@lwn.net>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Luca Ceresoli <luca.ceresoli@bootlin.com>
X-Mailer: b4 0.12.4
X-GND-Sasl: luca.ceresoli@bootlin.com
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable
autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test,
not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]);
Fri, 01 Dec 2023 05:11:25 -0800 (PST)
X-getmail-retrieved-from-mailbox: INBOX
X-GMAIL-THRID: 1784085268146020026
X-GMAIL-MSGID: 1784085268146020026
|
| Series |
docs: nvmem: minor improvements
|
|
Commit Message
Luca Ceresoli
Dec. 1, 2023, 1:10 p.m. UTC
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 <luca.ceresoli@bootlin.com>
---
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 supplying relevant nvmem configuration to nvmem_register(), on success core would return a valid nvmem_device pointer. -nvmem_unregister(nvmem) is used to unregister a previously registered provider. +nvmem_unregister() is used to unregister a previously registered provider. For example, a simple nvram case::