From patchwork Sun Dec 10 18:11:33 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 10103947 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 38E2D60329 for ; Sun, 10 Dec 2017 18:11:44 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2EAA629284 for ; Sun, 10 Dec 2017 18:11:44 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 22D6629287; Sun, 10 Dec 2017 18:11:44 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 61BBF29284 for ; Sun, 10 Dec 2017 18:11:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752171AbdLJSLl (ORCPT ); Sun, 10 Dec 2017 13:11:41 -0500 Received: from bombadil.infradead.org ([65.50.211.133]:57062 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752068AbdLJSLk (ORCPT ); Sun, 10 Dec 2017 13:11:40 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20170209; h=Content-Transfer-Encoding: Content-Type:MIME-Version:Date:Message-ID:Cc:To:Subject:From:Sender:Reply-To: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=DnTrjr8vU0B/GkAhh6iJdaowsnkyM6SyZabPcz1wQdc=; b=afk3XKg6Upz76Ox1jDc6deQOh YVhIWsekamgBcimbc28v9xLg17NW2u7o8bMM3Fy63l9GtRDOw7xL6pjkZh0aNG8NP9y+zD+umDEv0 43f9vKGGasFhpWepj0JYUPKsLK2GntmQC65J79dqrqmv7mPSGMXmqFs+YH5Wedma709MgYgHKXSVG 6yyXf5Wdap6UHvVEJBsUIO806Wn4Y6rICrVGBvBhwspwsnU6FuJesQkRqXSOYeiOa9zq0n8ieEvHo a/n/maC2ncFmIojmoFLYlF3LAqsHeD5DVytxvfVT5E/plD9QdpeOLwtHdCWd4JDRwcCp5doYp7/HV oWDKWTDTA==; Received: from static-50-53-52-16.bvtn.or.frontiernet.net ([50.53.52.16] helo=midway.dunlap) by bombadil.infradead.org with esmtpsa (Exim 4.87 #1 (Red Hat Linux)) id 1eO64c-0006g9-Q3; Sun, 10 Dec 2017 18:11:34 +0000 From: Randy Dunlap Subject: [PATCH] scsi: doc. fixes to scsi_common.c To: linux-scsi , "Martin K. Petersen" , "James E.J. Bottomley" Cc: "Nicholas A. Bellinger" , Sagi Grimberg , Bart Van Assche Message-ID: <95ed8abc-c9a7-4301-415b-cc6d327945ba@infradead.org> Date: Sun, 10 Dec 2017 10:11:33 -0800 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.5.0 MIME-Version: 1.0 Content-Language: en-US Sender: linux-scsi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Randy Dunlap Clean up some comment typos and fix some errors in documentation. Signed-off-by: Randy Dunlap Cc: Nicholas Bellinger Cc: Sagi Grimberg Cc: Bart Van Assche Reviewed-by: Bart Van Assche --- drivers/scsi/scsi_common.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) --- lnx-415-rc2.orig/drivers/scsi/scsi_common.c +++ lnx-415-rc2/drivers/scsi/scsi_common.c @@ -12,7 +12,7 @@ /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI. * You may not alter any existing entry (although adding new ones is - * encouraged once assigned by ANSI/INCITS T10 + * encouraged once assigned by ANSI/INCITS T10). */ static const char *const scsi_device_types[] = { "Direct-Access ", @@ -39,7 +39,7 @@ static const char *const scsi_device_typ }; /** - * scsi_device_type - Return 17 char string indicating device type. + * scsi_device_type - Return 17-char string indicating device type. * @type: type number to look up */ const char *scsi_device_type(unsigned type) @@ -59,7 +59,7 @@ EXPORT_SYMBOL(scsi_device_type); * @scsilun: struct scsi_lun to be converted. * * Description: - * Convert @scsilun from a struct scsi_lun to a four byte host byte-ordered + * Convert @scsilun from a struct scsi_lun to a four-byte host byte-ordered * integer, and return the result. The caller must check for * truncation before using this function. * @@ -98,7 +98,7 @@ EXPORT_SYMBOL(scsilun_to_int); * back into the lun value. * * Notes: - * Given an integer : 0x0b03d204, this function returns a + * Given an integer : 0x0b03d204, this function returns a * struct scsi_lun of: d2 04 0b 03 00 00 00 00 * */ @@ -221,7 +221,7 @@ EXPORT_SYMBOL(scsi_sense_desc_find); /** * scsi_build_sense_buffer - build sense data in a buffer - * @desc: Sense format (non zero == descriptor format, + * @desc: Sense format (non-zero == descriptor format, * 0 == fixed format) * @buf: Where to build sense data * @key: Sense key @@ -255,7 +255,7 @@ EXPORT_SYMBOL(scsi_build_sense_buffer); * @info: 64-bit information value to be set * * Return value: - * 0 on success or EINVAL for invalid sense buffer length + * 0 on success or -EINVAL for invalid sense buffer length **/ int scsi_set_sense_information(u8 *buf, int buf_len, u64 info) { @@ -305,7 +305,7 @@ EXPORT_SYMBOL(scsi_set_sense_information * @cd: command/data bit * * Return value: - * 0 on success or EINVAL for invalid sense buffer length + * 0 on success or -EINVAL for invalid sense buffer length */ int scsi_set_sense_field_pointer(u8 *buf, int buf_len, u16 fp, u8 bp, bool cd) {