lkml.org 
[lkml]   [2021]   [Jun]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v3 4/5] pstore/blk: Fix kerndoc and redundancy on blkdev param
    Date
    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>
    ---
    Documentation/admin-guide/pstore-blk.rst | 11 +++++++----
    fs/pstore/blk.c | 24 +-----------------------
    2 files changed, 8 insertions(+), 27 deletions(-)

    diff --git a/Documentation/admin-guide/pstore-blk.rst b/Documentation/admin-guide/pstore-blk.rst
    index 79f6d23e8cda..2d22ead9520e 100644
    --- a/Documentation/admin-guide/pstore-blk.rst
    +++ b/Documentation/admin-guide/pstore-blk.rst
    @@ -45,15 +45,18 @@ blkdev
    The block device to use. Most of the time, it is a partition of block device.
    It's required for pstore/blk. It is also used for MTD device.

    -It accepts the following variants for block device:
    +When pstore/blk is built as a module, "blkdev" accepts the following variants:

    -1. <hex_major><hex_minor> device number in hexadecimal represents itself; no
    - leading 0x, for example b302.
    -#. /dev/<disk_name> represents the device number of disk
    +1. /dev/<disk_name> represents the device number of disk
    #. /dev/<disk_name><decimal> represents the device number of partition - device
    number of disk plus the partition number
    #. /dev/<disk_name>p<decimal> - same as the above; this form is used when disk
    name of partitioned disk ends with a digit.
    +
    +When pstore/blk is built into the kernel, "blkdev" accepts the following variants:
    +
    +#. <hex_major><hex_minor> device number in hexadecimal representation,
    + with no leading 0x, for example b302.
    #. PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF represents the unique id of
    a partition if the partition table provides it. The UUID may be either an
    EFI/GPT UUID, or refer to an MSDOS partition using the format SSSSSSSS-PP,
    diff --git a/fs/pstore/blk.c b/fs/pstore/blk.c
    index dc5ff763d414..c373e0d73e6c 100644
    --- a/fs/pstore/blk.c
    +++ b/fs/pstore/blk.c
    @@ -58,29 +58,7 @@ MODULE_PARM_DESC(best_effort, "use best effort to write (i.e. do not require sto

    /*
    * blkdev - the block device to use for pstore storage
    - *
    - * Usually, this will be a partition of a block device.
    - *
    - * blkdev accepts the following variants, when built as a module:
    - * 1) /dev/<disk_name> represents the device number of disk
    - * 2) /dev/<disk_name><decimal> represents the device number
    - * of partition - device number of disk plus the partition number
    - * 3) /dev/<disk_name>p<decimal> - same as the above, that form is
    - * used when disk name of partitioned disk ends on a digit.
    - *
    - * blkdev accepts the following variants when built into the kernel:
    - * 1) <hex_major><hex_minor> device number in hexadecimal representation,
    - * with no leading 0x, for example b302.
    - * 2) PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF representing the
    - * unique id of a partition if the partition table provides it.
    - * The UUID may be either an EFI/GPT UUID, or refer to an MSDOS
    - * partition using the format SSSSSSSS-PP, where SSSSSSSS is a zero-
    - * filled hex representation of the 32-bit "NT disk signature", and PP
    - * is a zero-filled hex representation of the 1-based partition number.
    - * 3) PARTUUID=<UUID>/PARTNROFF=<int> to select a partition in relation to
    - * a partition with a known unique id.
    - * 4) <major>:<minor> major and minor number of the device separated by
    - * a colon.
    + * See Documentation/admin-guide/pstore-blk.rst for details.
    */
    static char blkdev[80] = CONFIG_PSTORE_BLK_BLKDEV;
    module_param_string(blkdev, blkdev, 80, 0400);
    --
    2.25.1
    \
     
     \ /
      Last update: 2021-06-16 18:41    [W:2.252 / U:0.260 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site