From patchwork Mon Apr 8 02:54:18 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620491 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E084EEDF; Mon, 8 Apr 2024 02:54:29 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; cv=none; b=Mf7RwY7JX0xuWTpMRKFjsPV3XdYGxVPVZOh83spblqXCYR7Y58SM2ajc+qfGm3eLfIu+kJo1sz/7+MuPtLifdkcfrs1rp4z4vF1C3PuMuiYUD6zGXQZy+mnMLiPpkAFpLFC+5cfIrfP40rQ0T+XynTq6vuPxHWNpiX0lB79H984= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; c=relaxed/simple; bh=hFGbtCl5brY3Pt2GD/u4g+tYb5eNQfC/ETHUn/YzcuY=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=CX6q5vagSTrfSY3UBYNMmxlBx2holXZTqxv8urzJp0pjl58jCiAixi4xHMKxspKsorS+fYqJ+9K9a2sPu9h4nLFaDfxtQDG3qdG1J0FUifV513s5dxiNSMIadbxfgMDTodXyIqsjK3rRDlTObO/DZIhRi1z+ASlPq47fVteKvmA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=3WyuTGNQ; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="3WyuTGNQ" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=gZjLvVyMMsmvznBcaR8J+pLQcmv/hNULLwXCOwRGZD4=; b=3WyuTGNQTpwtfemC1KGC97Shze Zak67SdWihVWJAjq4ctWxqCQhcJFsQEr3xtyqSmiBTk+HT3P5d1dZ/r5mq93S0vqVN066vjqVDkM1 Rnxb2SWhy8EIj4SgyH0IK4n+VC+EQgmKpEx5iRhy8UWE+07iYvMIBBbVGT+s1ATTfAwEfr6zJ3ji/ mN1BmXhuUHo3Z/jgjYH1E9w5bZuEvTZhoKOs/eJv+XYARwhbhI5zLXZC70lVOsWGyYpU28VXXMSfD m1mQobe1jDzefJpM+mXUTtMqlH3DTMOD5gg8BmypDzrMAPVjWcOWExCSUejwKzzyZuhtwdcTIvbmK R0RWNZ5g==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9R-0000000E7aj-0F1U; Mon, 08 Apr 2024 02:54:29 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH 1/8] scsi: documentation: clean up scsi_mid_low_api.rst Date: Sun, 7 Apr 2024 19:54:18 -0700 Message-ID: <20240408025425.18778-2-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 - update the format (txt to rst) and location of this document (archive.org to docs.kernel.org) - change url to URL - spell out "lk" (Linux Kernel) Signed-off-by: Randy Dunlap --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Documentation/scsi/scsi_mid_low_api.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff -- a/Documentation/scsi/scsi_mid_low_api.rst b/Documentation/scsi/scsi_mid_low_api.rst --- a/Documentation/scsi/scsi_mid_low_api.rst +++ b/Documentation/scsi/scsi_mid_low_api.rst @@ -42,18 +42,18 @@ This version of the document roughly mat Documentation ============= There is a SCSI documentation directory within the kernel source tree, -typically Documentation/scsi . Most documents are in plain -(i.e. ASCII) text. This file is named scsi_mid_low_api.txt and can be +typically Documentation/scsi . Most documents are in reStructuredText +format. This file is named scsi_mid_low_api.rst and can be found in that directory. A more recent copy of this document may be found -at http://web.archive.org/web/20070107183357rn_1/sg.torque.net/scsi/. -Many LLDs are documented there (e.g. aic7xxx.txt). The SCSI mid-level is -briefly described in scsi.txt which contains a url to a document -describing the SCSI subsystem in the lk 2.4 series. Two upper level -drivers have documents in that directory: st.txt (SCSI tape driver) and -scsi-generic.txt (for the sg driver). +at https://docs.kernel.org/scsi/scsi_mid_low_api.html. Many LLDs are +documented in Documentation/scsi (e.g. aic7xxx.rst). The SCSI mid-level is +briefly described in scsi.rst which contains a URL to a document describing +the SCSI subsystem in the Linux Kernel 2.4 series. Two upper level +drivers have documents in that directory: st.rst (SCSI tape driver) and +scsi-generic.rst (for the sg driver). -Some documentation (or urls) for LLDs may be found in the C source code -or in the same directory as the C source code. For example to find a url +Some documentation (or URLs) for LLDs may be found in the C source code +or in the same directory as the C source code. For example to find a URL about the USB mass storage driver see the /usr/src/linux/drivers/usb/storage directory. From patchwork Mon Apr 8 02:54:19 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620499 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5F28317F6; Mon, 8 Apr 2024 02:54:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544873; cv=none; b=h0TGWsH9TQJw3KKVfPxUxozURdxdQ2P/+KBjzMg4+4nnYXeF0gN9d1J9CZDDc1NXTi4lv/XWW179JTSvWde7+AjOEsQyXdgSPJuLVZSjDIxEPsnx6kC/dkKCifIhE2ZZJaQ3nMU4rNSjLb6cTQeMkgDJ18xyOixCmAnLQX6fMi4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544873; c=relaxed/simple; bh=CjHQSAs/mh7KvwpLNKOZpFwtDpyxl9qT46MrLzqQFHs=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=MBIS4+9hHNjVgXpoeIE2xc2bS1z9OCgIluKQ3qg5ie7nU7eXS7WU5rNXUkj6+mwEq9v4v2ksnS9h9DT81jTR7OOL2Sqzxq9TfDT7pZiPkMlNgedr2D8NRUWME5KuXRcT5Vf3PKNUSmnXxP/ym7uO1lmXQtPgRNt0gteu7IDmceo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=J/EuGFQd; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="J/EuGFQd" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=ZEHTsV/PPFpp5gLF3uDiZnD/ZI3q71c8eoDn6DumcMg=; b=J/EuGFQdPi0LFd//iPFHI4e9eG O4cPs70ywr6Qn9vJ6BwBs4kHUGaa/OrcJBSpwkJn1jbFmf0dJ4NAk1mTw669Ax9ti9YBB1TD7hlj8 5VLCaDzUCJFEB5n4dxNswaYb5+vjzMV6jVraA8zo4wKeN2Hcytpnij52wTqg7bi4+S/z7nIT61Or7 1RjbL0kjDGU2n//QeCy4WSEnzFJXuZcyQaWPFOwlme5H8IuXpaO95942AxIUprWf7gs2D2neMZA0q 7C8OlCUVxUdfx5CXADEe4i3uN01ix2T3WK+NkfETElFlNgfYFvGeAEV8bEO0yu71Hhv1pmlGqaxl8 zkmOG8BQ==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9R-0000000E7aj-2AkK; Mon, 08 Apr 2024 02:54:29 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" , Doug Gilbert , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH 2/8] scsi: documentation: clean up overview Date: Sun, 7 Apr 2024 19:54:19 -0700 Message-ID: <20240408025425.18778-3-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 - change http to https where the latter works - drop references to I2O (Intelligent I/O) - use lore.kernel.org instead of marc.info for email links - update the location of the scsi_debug documentation Signed-off-by: Randy Dunlap --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org Cc: Doug Gilbert Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Documentation/driver-api/scsi.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff -- a/Documentation/driver-api/scsi.rst b/Documentation/driver-api/scsi.rst --- a/Documentation/driver-api/scsi.rst +++ b/Documentation/driver-api/scsi.rst @@ -20,7 +20,7 @@ Although the old parallel (fast/wide/ult out of use, the SCSI command set is more widely used than ever to communicate with devices over a number of different busses. -The `SCSI protocol `__ is a big-endian +The `SCSI protocol `__ is a big-endian peer-to-peer packet based protocol. SCSI commands are 6, 10, 12, or 16 bytes long, often followed by an associated data payload. @@ -28,8 +28,7 @@ SCSI commands can be transported over ju are the default protocol for storage devices attached to USB, SATA, SAS, Fibre Channel, FireWire, and ATAPI devices. SCSI packets are also commonly exchanged over Infiniband, -`I2O `__, TCP/IP -(`iSCSI `__), even `Parallel +TCP/IP (`iSCSI `__), even `Parallel ports `__. Design of the Linux SCSI subsystem @@ -170,9 +169,9 @@ drivers/scsi/scsi_netlink.c Infrastructure to provide async events from transports to userspace via netlink, using a single NETLINK_SCSITRANSPORT protocol for all -transports. See `the original patch -submission `__ for -more details. +transports. See `the original patch submission +`__ +for more details. .. kernel-doc:: drivers/scsi/scsi_netlink.c :internal: @@ -328,11 +327,11 @@ the ordinary is seen. To be more realistic, the simulated devices have the transport attributes of SAS disks. -For documentation see http://sg.danny.cz/sg/sdebug26.html +For documentation see http://sg.danny.cz/sg/scsi_debug.html todo ~~~~ Parallel (fast/wide/ultra) SCSI, USB, SATA, SAS, Fibre Channel, -FireWire, ATAPI devices, Infiniband, I2O, Parallel ports, +FireWire, ATAPI devices, Infiniband, Parallel ports, netlink... From patchwork Mon Apr 8 02:54:20 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620492 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5C75E17C2 for ; Mon, 8 Apr 2024 02:54:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; cv=none; b=hCRWFuCmnaOVAQljqbFrSRv55CXqkLW1jRJ3JwNA6UNfRyW3L+dKC8GzO4QgCvZvj3cVutba6pDF1PjUe16jLdDY83M4ONKt5OpYiuNlHx/5EKPL75IipmuFMCcuGjxIfPwjmiH0s83Rr+dHmreeX2Kkkqw2YyLgmXdIRMrRgFA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; c=relaxed/simple; bh=zKjb/jPCMrQwXReBlD/nI3Zwb4e2eiuTkP82CQHSbXs=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=YwklWOUgPbOSQjS2o0E2v2LvZyk8YMpDu4RyuvltMQBStEmBv2fNTI77o4uktkk06O6A/Ic5cT2XgaABGtWmXkIFONsusjvvx5oLTbzxGjxSthb/DphsWalQkyVilPp4meaz77xneXWW4k2aq8hRLqOAjAWhNfQcZn0f1BSw+gk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=rPzHZnSb; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="rPzHZnSb" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=Uc5mqXNRr9J9NGsmtDt/wAh7o+QREKqBSBaqbFAcKUM=; b=rPzHZnSbVWsUdQgOlvhIpJNmWW uDDNK5D2kquJPl9e7nPntyvMZd7GuufN6dFKt70Qp6b2GnhwN0awQiIkLM4AgBsKaAtzsH476yNQ7 lSfDVR3XVCGF6TB3sLwhP/44fGf4V39cUtUgW521yCWU1QPz6jnop7GzoVvU44Js96MTa/zT0I44J ob9QtFwgqFc40XTquzCpZ0zHwXYg2GeXaIYou1EicnhhUjfOIjB37pChura1zgaTDFwta8wL3ssHd pQSUdVajn5zoUFpy0511Ptu3y/pIUESNZGLgsl6XyoDrwMOq1FW1dZNsl1dcNrhRCFDDDwDP67Ep/ 1BfgtxQw==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9R-0000000E7aj-3plK; Mon, 08 Apr 2024 02:54:29 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" Subject: [PATCH 3/8] scsi: core: add kernel-doc for scsi_msg_to_host_byte() Date: Sun, 7 Apr 2024 19:54:20 -0700 Message-ID: <20240408025425.18778-4-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Add entries for missing documentation to prevent kernel-doc warnings: scsi_cmnd.h:365: warning: Function parameter or struct member 'cmd' not described in 'scsi_msg_to_host_byte' scsi_cmnd.h:365: warning: Function parameter or struct member 'msg' not described in 'scsi_msg_to_host_byte' Signed-off-by: Randy Dunlap Reviewed-by: Bart Van Assche --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org include/scsi/scsi_cmnd.h | 2 ++ 1 file changed, 2 insertions(+) diff -- a/include/scsi/scsi_cmnd.h b/include/scsi/scsi_cmnd.h --- a/include/scsi/scsi_cmnd.h +++ b/include/scsi/scsi_cmnd.h @@ -353,6 +353,8 @@ static inline u8 get_host_byte(struct sc /** * scsi_msg_to_host_byte() - translate message byte + * @cmd: the SCSI command + * @msg: the SCSI parallel message byte to translate * * Translate the SCSI parallel message byte to a matching * host byte setting. A message of COMMAND_COMPLETE indicates From patchwork Mon Apr 8 02:54:21 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620493 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DD58617F7; Mon, 8 Apr 2024 02:54:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; cv=none; b=bWDS3PM26xRLobvpVnVdShpuGVGzzbgA7amV3RuzwqFHiEcdEtpMQDinWHfHaW+/BSlE8KQnbFBimd924voSkj7lNsQaDzGRx+2hJyYJzD5gBeC99ZtzLOoj4mIOnnYOiM4NaOCquntT6JIzFgoTAoSPvqrABjHqukJ2Agaetqg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; c=relaxed/simple; bh=94RvMc6Rf0UIsnYRM2ZlngrhDBe/mSI9V8l2Gsna8QA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=twA4HHnZv3gkuRizWXCMUZG5Hu9W1ypKTXMhg/aYDsfgv+j+fZHq5e/zsK01t4EwqKxM//CsoBw3+Y+GhBLyJPUHoOzaYL4fogcF3/5220lXNiusB6JpOtvE7/iZS9GL1wpGEKIOgcRIxKzgML8iUYljkvP8PsuC/mL8rwBZW+0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=s7zvsb0F; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="s7zvsb0F" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=sVZokRLRtK/U1jkTDOTUDvOWvOdsjK6uSS0rAvoMvMU=; b=s7zvsb0FszY3b8Zjx3MaQsPz6c J+9tShR/usOzuGoOe9mjdBVGE8Afqk9VwBM6KnmdVSQ4bt3/u20STOWDCBzyAK34uZdbPuWEigubv JO0GTIZJo6P0v/tDUbtKns/v2I15RPbLgYXaldVUNbvd7FKySEOuRN7ylM8S9UwlUXafqZeMwp3Aw 04wm3TKLe7mmnsSsv5G82rUlfORZyyj+NEALgljEUx2fXNOtysCoXj+ARLIeWlB0SSKVhSMAqnG5i SjxHPqpkySPz9kkWlX17RS/T2Zt3FR+upavdCEj0KAvYwqQOhkb6Om3t7B8s3VqiN3A6kUU9nDiaV l42C0+3w==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9S-0000000E7aj-106x; Mon, 08 Apr 2024 02:54:30 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" , Sagi Grimberg , Max Gurtovoy , linux-rdma@vger.kernel.org, target-devel@vger.kernel.org Subject: [PATCH 4/8] scsi: iser: fix @read_stag kernel-doc warning Date: Sun, 7 Apr 2024 19:54:21 -0700 Message-ID: <20240408025425.18778-5-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Correct kernel-doc comments for struct iser_ctrl to prevent warnings: iser.h:76: warning: Function parameter or struct member 'read_stag' not described in 'iser_ctrl' iser.h:76: warning: Excess struct member 'reaf_stag' description in 'iser_ctrl' Signed-off-by: Randy Dunlap Acked-by: Sagi Grimberg Reviewed-by: Max Gurtovoy --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org Cc: Sagi Grimberg Cc: Max Gurtovoy Cc: linux-rdma@vger.kernel.org Cc: target-devel@vger.kernel.org include/scsi/iser.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff -- a/include/scsi/iser.h b/include/scsi/iser.h --- a/include/scsi/iser.h +++ b/include/scsi/iser.h @@ -63,7 +63,7 @@ struct iser_cm_hdr { * @rsvd: reserved * @write_stag: write rkey * @write_va: write virtual address - * @reaf_stag: read rkey + * @read_stag: read rkey * @read_va: read virtual address */ struct iser_ctrl { From patchwork Mon Apr 8 02:54:22 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620494 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DEB2A184D for ; Mon, 8 Apr 2024 02:54:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; cv=none; b=A4KA7gnCO7kIbMvwB5mOqLqyfkaTiD7aR+HqLEeEOnHtxTP0To11hSV6UPp+q6+SmbvqnT1iq8ZOXOV84DoclEOciFJ+iQamDyFvHLPdASVMplEH+WSg/scfSbWFJSWJAkiwrD/YTWIPQQVMJJP3K7dOQ1x7VvSLWiJeDF+Pi6s= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; c=relaxed/simple; bh=pJLITAG0DGxLch/58v9ERkPQWB5PUdWf4MKw4QTg7OE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=CsRHKm6gx2pnv2Z6M7kir5xwOgdtzgMAoIhrzb/EfQdpXEl54GRlpacvdE1YXFZfBm9pflACLOzXLXgdorVUx3bSg6AYyBaixwgycfdHWTvGBMfRHMPNuCVipDfu86Dq7hHz1G2D2jSRoZ9L8fGtGVzMG4loGssk7uC6tG9Ab24= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=iJGW/HKa; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="iJGW/HKa" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=UVaoJyzLKt5P+feXrghAVBqnSV1yfyfLnRFeqcQxUw8=; b=iJGW/HKan+eFzLWPIl5Imnn7L9 CuiDOQM/afZLYtxqgEvMKSqyVnavOuOGDJDOO3VJBsk4ou7K2YHlQHapFHrz6fZMZv02MCHYSaEsC TzxpR5aJQrS34i/zjFXb9qBD7/qOUb68i081tdEOshGIwDiSRr4zSyl9oa8FaSmauAEjmQJ3Cfq7n ku7m24RlOXq2m3S/k3GcGv3a1raO82vZepTsV71zZx0XKIDHDTjYBwcRXI9st0gMnPTp7Wj/cLUiI nt9mEJWCwR1AWIXvmC35L2mwIWdmeLdxQqKNcPdxE6fR53vRDafmDSjVl1g+eaSKR/kSU9bM5cQc4 U1i7h4Gg==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9S-0000000E7aj-21Lh; Mon, 08 Apr 2024 02:54:30 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" , Hannes Reinecke Subject: [PATCH 5/8] scsi: libfcoe: fix a slew of kernel-doc warnings Date: Sun, 7 Apr 2024 19:54:22 -0700 Message-ID: <20240408025425.18778-6-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fix all kernel-doc warnings in : libfcoe.h:163: warning: Function parameter or struct member 'ctlr' not described in 'fcoe_ctlr_priv' libfcoe.h:163: warning: Excess function parameter 'cltr' description in 'fcoe_ctlr_priv' libfcoe.h:163: warning: No description found for return value of 'fcoe_ctlr_priv' libfcoe.h:218: warning: Function parameter or struct member 'fd_flags' not described in 'fcoe_fcf' libfcoe.h:218: warning: Excess struct member 'event' description in 'fcoe_fcf' libfcoe.h:240: warning: Function parameter or struct member 'rdata' not described in 'fcoe_rport' libfcoe.h:273: warning: No description found for return value of 'is_fip_mode' libfcoe.h:332: warning: Function parameter or struct member 'crc_eof_page' not described in 'fcoe_percpu_s' libfcoe.h:332: warning: Function parameter or struct member 'lock' not described in 'fcoe_percpu_s' libfcoe.h:332: warning: Excess struct member 'page' description in 'fcoe_percpu_s' libfcoe.h:362: warning: Function parameter or struct member 'data_src_addr' not described in 'fcoe_port' libfcoe.h:362: warning: Function parameter or struct member 'get_netdev' not described in 'fcoe_port' libfcoe.h:362: warning: Excess struct member 'data_srt_addr' description in 'fcoe_port' libfcoe.h:369: warning: No description found for return value of 'fcoe_get_netdev' libfcoe.h:386: warning: missing initial short description on line: * struct netdev_list libfcoe.h:393: warning: expecting prototype for struct netdev_list. Prototype was for struct fcoe_netdev_mapping instead Signed-off-by: Randy Dunlap --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org Cc: Hannes Reinecke include/scsi/libfcoe.h | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff -- a/include/scsi/libfcoe.h b/include/scsi/libfcoe.h --- a/include/scsi/libfcoe.h +++ b/include/scsi/libfcoe.h @@ -157,7 +157,9 @@ struct fcoe_ctlr { /** * fcoe_ctlr_priv() - Return the private data from a fcoe_ctlr - * @cltr: The fcoe_ctlr whose private data will be returned + * @ctlr: The fcoe_ctlr whose private data will be returned + * + * Returns: pointer to the private data */ static inline void *fcoe_ctlr_priv(const struct fcoe_ctlr *ctlr) { @@ -174,7 +176,6 @@ static inline void *fcoe_ctlr_priv(const * struct fcoe_fcf - Fibre-Channel Forwarder * @list: list linkage * @event_work: Work for FC Transport actions queue - * @event: The event to be processed * @fip: The controller that the FCF was discovered on * @fcf_dev: The associated fcoe_fcf_device instance * @time: system time (jiffies) when an advertisement was last received @@ -188,6 +189,7 @@ static inline void *fcoe_ctlr_priv(const * @flogi_sent: current FLOGI sent to this FCF * @flags: flags received from advertisement * @fka_period: keep-alive period, in jiffies + * @fd_flags: no need for FKA from ENode * * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that * passes FCoE frames on to an FC fabric. This structure represents @@ -222,6 +224,7 @@ struct fcoe_fcf { /** * struct fcoe_rport - VN2VN remote port + * @rdata: libfc remote port private data * @time: time of create or last beacon packet received from node * @fcoe_len: max FCoE frame size, not including VLAN or Ethernet headers * @flags: flags from probe or claim @@ -266,8 +269,10 @@ void fcoe_get_lesb(struct fc_lport *, st void fcoe_ctlr_get_lesb(struct fcoe_ctlr_device *ctlr_dev); /** - * is_fip_mode() - returns true if FIP mode selected. + * is_fip_mode() - test if FIP mode selected. * @fip: FCoE controller. + * + * Returns: %true if FIP mode is selected */ static inline bool is_fip_mode(struct fcoe_ctlr *fip) { @@ -318,9 +323,10 @@ struct fcoe_transport { * @kthread: The thread context (used by bnx2fc) * @work: The work item (used by fcoe) * @fcoe_rx_list: The queue of pending packets to process - * @page: The memory page for calculating frame trailer CRCs + * @crc_eof_page: The memory page for calculating frame trailer CRCs * @crc_eof_offset: The offset into the CRC page pointing to available * memory for a new trailer + * @lock: local lock for members of this struct */ struct fcoe_percpu_s { struct task_struct *kthread; @@ -343,7 +349,8 @@ struct fcoe_percpu_s { * @timer: The queue timer * @destroy_work: Handle for work context * (to prevent RTNL deadlocks) - * @data_srt_addr: Source address for data + * @data_src_addr: Source address for data + * @get_netdev: function that returns a &net_device from @lport * * An instance of this structure is to be allocated along with the * Scsi_Host and libfc fc_lport structures. @@ -364,6 +371,8 @@ struct fcoe_port { /** * fcoe_get_netdev() - Return the net device associated with a local port * @lport: The local port to get the net device from + * + * Returns: the &net_device associated with this @lport */ static inline struct net_device *fcoe_get_netdev(const struct fc_lport *lport) { @@ -383,8 +392,10 @@ void fcoe_fcf_get_selected(struct fcoe_f void fcoe_ctlr_set_fip_mode(struct fcoe_ctlr_device *); /** - * struct netdev_list - * A mapping from netdevice to fcoe_transport + * struct fcoe_netdev_mapping - A mapping from &net_device to &fcoe_transport + * @list: list linkage of the mappings + * @netdev: the &net_device + * @ft: the fcoe_transport associated with @netdev */ struct fcoe_netdev_mapping { struct list_head list; From patchwork Mon Apr 8 02:54:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620495 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4BA531851 for ; Mon, 8 Apr 2024 02:54:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; cv=none; b=gtEA81ngxJD1taJZHT/Df7oYuW1WH13/cG/ZUPWinR4AvvwrOLAsHcnmhU7/Peww+p+EX64JGGKbHAJx4JoBc5C+yXYW1GhdTX6kFCtL3ciSEPnpKiN4X0wIJJZ+FFO+kb1bzq7aTrfUJesm+8H65C+1FCPIhm7Re/NPRvzhPrc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; c=relaxed/simple; bh=VSyo0pB3X9BLneWOTlh2jgboHkV7iglD354DSaJZFVg=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=eb1JiMoHSfkEWbwIBfNvU9BivPf+DfcU5Qj/VrOzXAENA2aKWl7LeJhDheh7FzCAgeDW6OLY37eJrFq/mT+LHsAQsrU6gdxdUQIzr2oQPOBETAVQJvyZW0YI5wEsCNN9duEdNSGNvN5xN13+uwaGC/WL2nvMwFr5G69gih4gXfI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=Td0YRQTa; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="Td0YRQTa" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=GU7fnRDSD1+YKZpJx5qe/WUhhFcKN3vni7bJr8SxaJM=; b=Td0YRQTah/qnPigNKkuoyqedu9 ALVQm/qyY7OU7tsAOKvlodgGtk+8MvyHljn8nMHRSY4GHTRGnIrkRjfldfrc0WoC5H1gZqfTErnKQ Ri7WQnbtnHadZty1arugzymXJgE3CqVia0WtWu5nnOFhI7tibQrmDVaFrLJvnKR15OlU5va2ooh+Y /uy2W0yLBhFjgGu18adhMXaBYHF+8dnoPVjlx7GEnOixW4w44nirm4wfgZTTh11xEhZT62ImS+ajt /LcvuqqlrjAqyCRTa5iZdGz2l8mQTkzQLwRIWbnkID1VBueb7yeJWqUXp62Sej7yABGRqqkxNAqrH 76Ezj9IQ==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9S-0000000E7aj-2zx2; Mon, 08 Apr 2024 02:54:30 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" Subject: [PATCH 6/8] scsi: core: add function return kernel-doc for 2 functions Date: Sun, 7 Apr 2024 19:54:23 -0700 Message-ID: <20240408025425.18778-7-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Add missing function return values to prevent kernel-doc warnings: scsi.h:75: warning: No description found for return value of 'scsi_status_is_check_condition' scsi.h:202: warning: No description found for return value of 'scsi_status_is_good' Signed-off-by: Randy Dunlap Reviewed-by: Bart Van Assche --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org include/scsi/scsi.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff -- a/include/scsi/scsi.h b/include/scsi/scsi.h --- a/include/scsi/scsi.h +++ b/include/scsi/scsi.h @@ -69,7 +69,7 @@ static inline int scsi_is_wlun(u64 lun) * @status: the status passed up from the driver (including host and * driver components) * - * This returns true if the status code is SAM_STAT_CHECK_CONDITION. + * Returns: %true if the status code is SAM_STAT_CHECK_CONDITION. */ static inline int scsi_status_is_check_condition(int status) { @@ -189,12 +189,13 @@ enum scsi_disposition { /* Used to obtain the PCI location of a device */ #define SCSI_IOCTL_GET_PCI 0x5387 -/** scsi_status_is_good - check the status return. +/** + * scsi_status_is_good - check the status return. * * @status: the status passed up from the driver (including host and * driver components) * - * This returns true for known good conditions that may be treated as + * Returns: %true for known good conditions that may be treated as * command completed normally */ static inline bool scsi_status_is_good(int status) From patchwork Mon Apr 8 02:54:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620496 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 91B851852 for ; Mon, 8 Apr 2024 02:54:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; cv=none; b=t8En7raADpAUBIL06gTMlgJhRIzUnCemgq8QZQi+lw70EH2duQQHPne6yqL6D3C0qC2manktjLsSuvgdSmokwdWYKmYbqKB/xM0tmaC1pP5YI6Z5uqF4AtaeaDqwcKmXYqtg3pUJp9kvDWiwFHpAAphjHHExJ8Ed0eFef4Bzb5Q= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544872; c=relaxed/simple; bh=cOMF66qtRKrf57DQRiV6olcX9uzVeCSkqZoNpTNq/cs=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=LFU8gXPkWgMfHWBOeJwNfN1l7G+diHQ+tPGfhu5VxernrBLQzlrFXA6rsVCQ+jmCVw+XkuFiVWEj4xnZ3bC65OwFVmFL3bq6iJGiS5K3+AzlsI5mbF7l7wyAyXTzIYIdKWtACssy2mrQ2DvaW8jIqp8fxkn8Z5WP3/dCNNcEOQM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=YWR9OYnZ; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="YWR9OYnZ" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=qPP2o8ZO1A5+FEv1JPt3M6daAduWEaNfV+ef7kfphK8=; b=YWR9OYnZ3lvjmEqaL56eb1mD7S rBogRrUDcAhHk4DQ5w7H7dKpmSnaXPnBkVybrexUTGKy4amiRNa1+cZUA6ssGSBGjpyrVXU+LbvSB DB0GiYPz3nYNMJjToZlciXstxiJvCVQIJhoIWTkdno9ntk6193C15SxTLbgfQr6HJ2jQ0UgS7c+US l45NDmVLWnIvvEQqLEO8LrnTtcO5sqBan5mxJcr9FR+I92unhSaRGOHKY/RrFuEHGfZN4eX7/APrn AVoqVnRCRSH9Zz3XnmhJJTFyXiB82IGuTUjR11jL+il8etNyY8wLUcWNkYpWsxc0GVGG1V/lsra0m 8FyF1xHQ==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9S-0000000E7aj-3tsA; Mon, 08 Apr 2024 02:54:31 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" Subject: [PATCH 7/8] scsi: scsi_transport_fc: add kernel-doc for function return Date: Sun, 7 Apr 2024 19:54:24 -0700 Message-ID: <20240408025425.18778-8-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Add function return value to prevent a kernel-doc warning: scsi_transport_fc.h:780: warning: No description found for return value of 'fc_remote_port_chkready' Signed-off-by: Randy Dunlap --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org include/scsi/scsi_transport_fc.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff -- a/include/scsi/scsi_transport_fc.h b/include/scsi/scsi_transport_fc.h --- a/include/scsi/scsi_transport_fc.h +++ b/include/scsi/scsi_transport_fc.h @@ -770,10 +770,9 @@ struct fc_function_template { /** * fc_remote_port_chkready - called to validate the remote port state * prior to initiating io to the port. - * - * Returns a scsi result code that can be returned by the LLDD. - * * @rport: remote port to be checked + * + * Returns: a scsi result code that can be returned by the LLDD. **/ static inline int fc_remote_port_chkready(struct fc_rport *rport) From patchwork Mon Apr 8 02:54:25 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13620497 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D21431860 for ; Mon, 8 Apr 2024 02:54:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544873; cv=none; b=P1Se/7bvvP5hjuQzQmFl4zCvH2QBm6iFkWDwP2QTnRJv9yOuvs4s5iCY3W1JbmefB6IAucfrYNpCMH9+Di3BAVcvmyAGGG0ZpebQV5f20QS56I5w6iVhz8Wd+Y2MAtiodB1WVFe8jftfXA5vg3QxYwhWMGTs4WWhjHBGS6kOkwc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712544873; c=relaxed/simple; bh=fZ0ki1BC5nv0GPcsixNa0dxew2Ji6gEyUwdq1J6SUuc=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Y1QJf0MDdfXd5t9xN2aDqGD806q9R6304AYEfw+axlbooh1zxrQBdYw7n2JF1RjJ0JFOIJEiLBjO0A1PpP+Vz+Wy0H2I20Tt/4lClzr4shPY/5dzuI3vpg2qrfTFtFyEiE/2K1rEmxFaVLsETuNx4bdvo0/X4aVSJ3A5rxxwO10= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=m//9W+Jb; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="m//9W+Jb" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=VM+0J8e+0hA4kWELiu8/dsyjlme/YSoD1PnAY52mqVw=; b=m//9W+Jbl79oWI305kgQOUTq0P ghQg44oNbc5sXoSfoWUjEWyuSOEYOunxB4zdeoWDsG/Dr+ODBy9nMY/L4e6TrnUMo1bjXiNph21oc DUhJ6LM2emD3g1O8hFDuoIWaIANtF72q2GQx25uJRaYIydh8GVFG+dFZw3HZboly7XoQ8hF7JCMh4 C1UZ3d9oJtoHMqBz47Kw7HGpjO2Pf6ydtXlBq8w2vo5DDERZELTlCkgp0gOaTmXHpxtxgBTXDcsdM JR9wFPgc8RXpbXXGmM3iQkISFJUSLYmXqxfW0fIFH4+oEOgsEsYwe89MpCy1cSIRYlPnNeEWAVEeS wuDu1ywQ==; Received: from [50.53.2.121] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtf9T-0000000E7aj-0lHZ; Mon, 08 Apr 2024 02:54:31 +0000 From: Randy Dunlap To: linux-scsi@vger.kernel.org Cc: Randy Dunlap , "James E.J. Bottomley" , "Martin K. Petersen" , Bart Van Assche Subject: [PATCH 8/8] scsi: scsi_transport_srp: fix a couple of kernel-doc warnings Date: Sun, 7 Apr 2024 19:54:25 -0700 Message-ID: <20240408025425.18778-9-rdunlap@infradead.org> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240408025425.18778-1-rdunlap@infradead.org> References: <20240408025425.18778-1-rdunlap@infradead.org> Precedence: bulk X-Mailing-List: linux-scsi@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Add a struct short description and a function return value to prevent kernel-doc warnings: scsi_transport_srp.h:77: warning: missing initial short description on line: * struct srp_function_template scsi_transport_srp.h:132: warning: No description found for return value of 'srp_chkready' Signed-off-by: Randy Dunlap Reviewed-by: Bart Van Assche --- Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: linux-scsi@vger.kernel.org Cc: Bart Van Assche include/scsi/scsi_transport_srp.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff -- a/include/scsi/scsi_transport_srp.h b/include/scsi/scsi_transport_srp.h --- a/include/scsi/scsi_transport_srp.h +++ b/include/scsi/scsi_transport_srp.h @@ -74,7 +74,7 @@ struct srp_rport { }; /** - * struct srp_function_template + * struct srp_function_template - template for SRP initiator drivers * * Fields that are only relevant for SRP initiator drivers: * @has_rport_state: Whether or not to create the state, fast_io_fail_tmo and @@ -124,7 +124,7 @@ enum scsi_timeout_action srp_timed_out(s * srp_chkready() - evaluate the transport layer state before I/O * @rport: SRP target port pointer. * - * Returns a SCSI result code that can be returned by the LLD queuecommand() + * Returns: a SCSI result code that can be returned by the LLD queuecommand() * implementation. The role of this function is similar to that of * fc_remote_port_chkready(). */