From patchwork Sat Sep 5 21:03:00 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4gUHJhZG8=?= X-Patchwork-Id: 257734 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=-9.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED autolearn=unavailable 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 6C199C43461 for ; Sat, 5 Sep 2020 21:03:25 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id CD09B20738 for ; Sat, 5 Sep 2020 21:03:24 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=protonmail.com header.i=@protonmail.com header.b="nUA7y/Sn" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728687AbgIEVDH (ORCPT ); Sat, 5 Sep 2020 17:03:07 -0400 Received: from mail-40134.protonmail.ch ([185.70.40.134]:34639 "EHLO mail-40134.protonmail.ch" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728426AbgIEVDG (ORCPT ); Sat, 5 Sep 2020 17:03:06 -0400 Date: Sat, 05 Sep 2020 21:03:00 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail; t=1599339783; bh=LMc0+1Hk9Afqm2G2fAFvBrU4ZxBzAUSkkiTlQeegv3s=; h=Date:To:From:Cc:Reply-To:Subject:From; b=nUA7y/Sn9q9y//BxtOdoNpUQnuv7q0AcPHKpHu7vsmNhgKtCQOVv2+ghMkLiHRjx7 3wsnrmvURegws2+JgOYC0WJ8Km+hUm0G+RBkMOPRKJ/VfaYjnmBPe8EdNGeaA1iQnD z1Va/YFrz7JTG2uLW1r8QyeTuRDq+d1gy+avWtSE= To: "Martin K . Petersen" , "James E . J . Bottomley" , Jonathan Corbet From: =?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4gUHJhZG8=?= Cc: linux-scsi@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Randy Dunlap , lkcamp@lists.libreplanetbr.org, andrealmeid@collabora.com Reply-To: =?utf-8?b?TsOtY29sYXMgRi4gUi4gQS4gUHJhZG8=?= Subject: [PATCH] scsi: docs: Remove obsolete scsi typedef text from scsi_mid_low_api Message-ID: <20200905210211.2286172-1-nfraprado@protonmail.com> MIME-Version: 1.0 Sender: linux-scsi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org Commit 91ebc1facd77 ("scsi: core: remove Scsi_Cmnd typedef") removed the Scsi_cmnd typedef but it was still mentioned in a paragraph in the "SCSI mid_level - lower_level driver interface" documentation page. Remove this obsolete paragraph. Suggested-by: Randy Dunlap Suggested-by: Jonathan Corbet Signed-off-by: Nícolas F. R. A. Prado Acked-by: Randy Dunlap --- Hi, Is this documentation page still relevant or should it be removed? I'm asking since it hasn't been updated in a while and there's mention of 2.6 kernel. In case it is still relevant, would patches changing the embedded kernel-docs for references to the kernel-docs in the source files be welcome? Also, I see that for example, scsi_add_device, has a kernel-doc in this page, even though there isn't any in the source code. Would a patch moving this function description to the source code be welcome? Thanks, Nícolas Documentation/scsi/scsi_mid_low_api.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/Documentation/scsi/scsi_mid_low_api.rst b/Documentation/scsi/scsi_mid_low_api.rst index 5358bc10689e..5bc17d012b25 100644 --- a/Documentation/scsi/scsi_mid_low_api.rst +++ b/Documentation/scsi/scsi_mid_low_api.rst @@ -271,12 +271,6 @@ Conventions First, Linus Torvalds's thoughts on C coding style can be found in the Documentation/process/coding-style.rst file. -Next, there is a movement to "outlaw" typedefs introducing synonyms for -struct tags. Both can be still found in the SCSI subsystem, but -the typedefs have been moved to a single file, scsi_typedefs.h to -make their future removal easier, for example: -"typedef struct scsi_cmnd Scsi_Cmnd;" - Also, most C99 enhancements are encouraged to the extent they are supported by the relevant gcc compilers. So C99 style structure and array initializers are encouraged where appropriate. Don't go too far,