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

pstore/blk: Fix kerndoc and redundancy on blkdev param

Remove redundant details of blkdev and fix up resulting kerndoc.

Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Kees Cook <keescook@chromium.org>

+8 -27
+7 -4
Documentation/admin-guide/pstore-blk.rst
··· 45 45 The block device to use. Most of the time, it is a partition of block device. 46 46 It's required for pstore/blk. It is also used for MTD device. 47 47 48 - It accepts the following variants for block device: 48 + When pstore/blk is built as a module, "blkdev" accepts the following variants: 49 49 50 - 1. <hex_major><hex_minor> device number in hexadecimal represents itself; no 51 - leading 0x, for example b302. 52 - #. /dev/<disk_name> represents the device number of disk 50 + 1. /dev/<disk_name> represents the device number of disk 53 51 #. /dev/<disk_name><decimal> represents the device number of partition - device 54 52 number of disk plus the partition number 55 53 #. /dev/<disk_name>p<decimal> - same as the above; this form is used when disk 56 54 name of partitioned disk ends with a digit. 55 + 56 + When pstore/blk is built into the kernel, "blkdev" accepts the following variants: 57 + 58 + #. <hex_major><hex_minor> device number in hexadecimal representation, 59 + with no leading 0x, for example b302. 57 60 #. PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF represents the unique id of 58 61 a partition if the partition table provides it. The UUID may be either an 59 62 EFI/GPT UUID, or refer to an MSDOS partition using the format SSSSSSSS-PP,
+1 -23
fs/pstore/blk.c
··· 58 58 59 59 /* 60 60 * blkdev - the block device to use for pstore storage 61 - * 62 - * Usually, this will be a partition of a block device. 63 - * 64 - * blkdev accepts the following variants, when built as a module: 65 - * 1) /dev/<disk_name> represents the device number of disk 66 - * 2) /dev/<disk_name><decimal> represents the device number 67 - * of partition - device number of disk plus the partition number 68 - * 3) /dev/<disk_name>p<decimal> - same as the above, that form is 69 - * used when disk name of partitioned disk ends on a digit. 70 - * 71 - * blkdev accepts the following variants when built into the kernel: 72 - * 1) <hex_major><hex_minor> device number in hexadecimal representation, 73 - * with no leading 0x, for example b302. 74 - * 2) PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF representing the 75 - * unique id of a partition if the partition table provides it. 76 - * The UUID may be either an EFI/GPT UUID, or refer to an MSDOS 77 - * partition using the format SSSSSSSS-PP, where SSSSSSSS is a zero- 78 - * filled hex representation of the 32-bit "NT disk signature", and PP 79 - * is a zero-filled hex representation of the 1-based partition number. 80 - * 3) PARTUUID=<UUID>/PARTNROFF=<int> to select a partition in relation to 81 - * a partition with a known unique id. 82 - * 4) <major>:<minor> major and minor number of the device separated by 83 - * a colon. 61 + * See Documentation/admin-guide/pstore-blk.rst for details. 84 62 */ 85 63 static char blkdev[80] = CONFIG_PSTORE_BLK_BLKDEV; 86 64 module_param_string(blkdev, blkdev, 80, 0400);