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 X-Spam-Level: X-Spam-Status: No, score=-13.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EEE13C43457 for ; Tue, 13 Oct 2020 11:55:21 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9DFBC22246 for ; Tue, 13 Oct 2020 11:55:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590121; bh=A7lLnKa6YyaQtK0OX9oslHuXqmGCRzRwzf23PGqcyNU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=pII46jx9druBfLgx5ty1HyvE9gGsqyKhOS39JBaQPZ+zo/XmiMvorsm80i/vaMCol d3iMK2wS+nGlcjeI/omQISvbM2VBCB9UqOO1bfp/aQyJagT9/3EI9TsYUwKMQ8nJNa 65QQx/9+lrWk5iRVM7/gr+fHqcvsfqKE/q2627BU= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727792AbgJMLzU (ORCPT ); Tue, 13 Oct 2020 07:55:20 -0400 Received: from mail.kernel.org ([198.145.29.99]:57420 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727721AbgJMLzD (ORCPT ); Tue, 13 Oct 2020 07:55:03 -0400 Received: from mail.kernel.org (ip5f5ad5b2.dynamic.kabel-deutschland.de [95.90.213.178]) (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 867C8229C7; Tue, 13 Oct 2020 11:54:41 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1602590081; bh=A7lLnKa6YyaQtK0OX9oslHuXqmGCRzRwzf23PGqcyNU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=es+mVdswFam7SjIexEi+YO/n+dft4hdbRCZNDKezrWfwE7ve0K+RUvGiSa/10grNz f4Q4Y0aGZJrTh6bjs+rMSeswIFeZT6zqt9cn4PDbs7/Y7B+jvS7a50mUBuFG6UY8xR buIgrkXjonIoVIXxmOFxbwgtrYG8NJ/m3e2YXnyo= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kSIt4-006CUg-J8; Tue, 13 Oct 2020 13:54:38 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Anton Vorontsov , Colin Cross , Kees Cook , Tony Luck , linux-kernel@vger.kernel.org Subject: [PATCH v6 34/80] docs: pstore-blk.rst: fix kernel-doc tags Date: Tue, 13 Oct 2020 13:53:49 +0200 Message-Id: <34ea299db48fdff99991a245d5d88040e498a16a.1602589096.git.mchehab+huawei@kernel.org> 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-doc@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. Acked-by: Kees Cook 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