Received: by 2002:a05:6a10:22f:0:0:0:0 with SMTP id 15csp4569782pxk; Wed, 30 Sep 2020 06:29:47 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwZJqk5i+cThYRaTdyUGHsKzrLdb5nl6ulaHqC6la5KwvKguEJ1svoH3g0v0omuKtVgujFy X-Received: by 2002:a50:eb0a:: with SMTP id y10mr2808979edp.89.1601472587575; Wed, 30 Sep 2020 06:29:47 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1601472587; cv=none; d=google.com; s=arc-20160816; b=HNTkPqGa0q3Ac1ZodLPeZwS8J5VYwk3i3nsbq4B9RCid/qVJ8hYcGcnYdb8XL7Dj69 GGXJC4LeArVhvJQAU4KoE0dJDpAS66Hg4jhBmXv1HrnIRix1LfjkLrQqrkburQsEGJXG kxfqsUGBI6cSOXwPzdqSN4yqjmWNE2PMnHDtPjW30sGapQfSKxPImV1Zcc4p5MCURRxO cLgk2PwcLdg79XCr020C7P9MXUXDz29zr+p5Nd9Od8kIm3zqGz7Nw5PMOAYrzJiy4WIp lQQuKV2XOrpTSLDIK6q9mRzowPu/Al8bgtt99M7N0EcmuIa4hkqFGVzym5JdoTmj9sgU 3o8g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=Ju4aP7QYPzHNuyidDISpZyEXCa6yHw5NSTIrUsG/Deo=; b=H7lq9AREwZNbf+G+OOWWfJj9DhS3xzwja3OLxG4eEgh9iwYNjCRcRDy/Y4ZGEIImGe 116+/QWlHVYx03CVbjwFhyEp4so8u2AYfag9uYBLHpGJvGlVkKjnQxwliMwRFUjWOtuU 9XNs6fMD0NBumyZAtdc5cEj6Qvdi75Cq285U+upeQjeHNJ1hOpBHgrVk5qt84xA1vOua VucY/ZhKH+RWmuCeveyjWJ2ouyHEsaLVBCR+WfwsndjTwoxCipI+jvfKA8jpVtl07/pg 5x+4uC/ns3xOdcQgU0+b7sxY7t1/bTR+gJU/YihHXjpD/plzs5x8KfYcpcah/jsMkjWm GDnA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=0WyNHjVb; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id qc14si1245129ejb.379.2020.09.30.06.29.24; Wed, 30 Sep 2020 06:29:47 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=0WyNHjVb; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1730681AbgI3N1c (ORCPT + 99 others); Wed, 30 Sep 2020 09:27:32 -0400 Received: from mail.kernel.org ([198.145.29.99]:39342 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730233AbgI3NZW (ORCPT ); Wed, 30 Sep 2020 09:25:22 -0400 Received: from mail.kernel.org (unknown [95.90.213.196]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 118AF2396E; Wed, 30 Sep 2020 13:25:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601472321; bh=e7SfKQrnoPiyPXMeWnFCrrMuZKgfoFc+6m9qIBd4Co8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=0WyNHjVbNbrfOzppAg+kfW64BBPedCDGME0Nvbc01eyD8XRRctg7IDDoT692BJlSu r1CNdI1jnvQADpBjKMeDMKchzpBNTVjynD0oiWEl223pScxWm2B9pRQbnp8Idk1sYS jnzaoueyCTrhz1xIXDunArRnUqSSJsAi7w2eoGTM= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kNc6h-001XKP-5a; Wed, 30 Sep 2020 15:25:19 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Jonathan Corbet Cc: Mauro Carvalho Chehab , Anton Vorontsov , Colin Cross , Kees Cook , Tony Luck , linux-kernel@vger.kernel.org Subject: [PATCH v4 34/52] docs: pstore-blk.rst: fix kernel-doc tags Date: Wed, 30 Sep 2020 15:24:57 +0200 Message-Id: X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org There is currently a problem with kernel-doc tags from blk.c: .../Documentation/admin-guide/pstore-blk:239: ./fs/pstore/blk.c:175: WARNING: Duplicate C declaration, also defined in 'admin-guide/pstore-blk'. Declaration is 'register_pstore_device'. .../Documentation/admin-guide/pstore-blk:239: ./fs/pstore/blk.c:432: WARNING: Duplicate C declaration, also defined in 'admin-guide/pstore-blk'. Declaration is 'register_pstore_blk'. .../Documentation/admin-guide/pstore-blk:242: ./include/linux/pstore_blk.h:43: WARNING: Duplicate C declaration, also defined in 'admin-guide/pstore-blk'. Declaration is 'pstore_device_info'. Basically, the internal parts is shown with :export:, instead of :internal:. Yet, there are some other exported docs that aren't at the document, because they lack :identifiers:. So, instead, let's just use :export: at the kAPI part of the documentation. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/pstore-blk.rst | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/Documentation/admin-guide/pstore-blk.rst b/Documentation/admin-guide/pstore-blk.rst index 296d5027787a..6898aba9fb5c 100644 --- a/Documentation/admin-guide/pstore-blk.rst +++ b/Documentation/admin-guide/pstore-blk.rst @@ -154,17 +154,11 @@ Configurations for driver Only a block device driver cares about these configurations. A block device driver uses ``register_pstore_blk`` to register to pstore/blk. -.. kernel-doc:: fs/pstore/blk.c - :identifiers: register_pstore_blk - A non-block device driver uses ``register_pstore_device`` with ``struct pstore_device_info`` to register to pstore/blk. .. kernel-doc:: fs/pstore/blk.c - :identifiers: register_pstore_device - -.. kernel-doc:: include/linux/pstore_blk.h - :identifiers: pstore_device_info + :export: Compression and header ---------------------- @@ -237,7 +231,7 @@ For developer reference, here are all the important structures and APIs: :internal: .. kernel-doc:: fs/pstore/blk.c - :export: + :internal: .. kernel-doc:: include/linux/pstore_blk.h :internal: -- 2.26.2