Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

scsi: core: doc. fixes to scsi_common.c

Clean up some comment typos and fix some errors in documentation.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Nicholas Bellinger <nab@linux-iscsi.org>
Cc: Sagi Grimberg <sagig@mellanox.com>
Cc: Bart Van Assche <bart.vanassche@wdc.com>
Reviewed-by: Bart Van Assche <bart.vanassche@wdc.com>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>

authored by

Randy Dunlap and committed by
Martin K. Petersen
749a1122 3c62ecda

+7 -7
+7 -7
drivers/scsi/scsi_common.c
··· 12 12 13 13 /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI. 14 14 * You may not alter any existing entry (although adding new ones is 15 - * encouraged once assigned by ANSI/INCITS T10 15 + * encouraged once assigned by ANSI/INCITS T10). 16 16 */ 17 17 static const char *const scsi_device_types[] = { 18 18 "Direct-Access ", ··· 39 39 }; 40 40 41 41 /** 42 - * scsi_device_type - Return 17 char string indicating device type. 42 + * scsi_device_type - Return 17-char string indicating device type. 43 43 * @type: type number to look up 44 44 */ 45 45 const char *scsi_device_type(unsigned type) ··· 59 59 * @scsilun: struct scsi_lun to be converted. 60 60 * 61 61 * Description: 62 - * Convert @scsilun from a struct scsi_lun to a four byte host byte-ordered 62 + * Convert @scsilun from a struct scsi_lun to a four-byte host byte-ordered 63 63 * integer, and return the result. The caller must check for 64 64 * truncation before using this function. 65 65 * ··· 98 98 * back into the lun value. 99 99 * 100 100 * Notes: 101 - * Given an integer : 0x0b03d204, this function returns a 101 + * Given an integer : 0x0b03d204, this function returns a 102 102 * struct scsi_lun of: d2 04 0b 03 00 00 00 00 103 103 * 104 104 */ ··· 221 221 222 222 /** 223 223 * scsi_build_sense_buffer - build sense data in a buffer 224 - * @desc: Sense format (non zero == descriptor format, 224 + * @desc: Sense format (non-zero == descriptor format, 225 225 * 0 == fixed format) 226 226 * @buf: Where to build sense data 227 227 * @key: Sense key ··· 255 255 * @info: 64-bit information value to be set 256 256 * 257 257 * Return value: 258 - * 0 on success or EINVAL for invalid sense buffer length 258 + * 0 on success or -EINVAL for invalid sense buffer length 259 259 **/ 260 260 int scsi_set_sense_information(u8 *buf, int buf_len, u64 info) 261 261 { ··· 305 305 * @cd: command/data bit 306 306 * 307 307 * Return value: 308 - * 0 on success or EINVAL for invalid sense buffer length 308 + * 0 on success or -EINVAL for invalid sense buffer length 309 309 */ 310 310 int scsi_set_sense_field_pointer(u8 *buf, int buf_len, u16 fp, u8 bp, bool cd) 311 311 {