From patchwork Sat Aug 5 16:23:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Golle X-Patchwork-Id: 131508 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:c44e:0:b0:3f2:4152:657d with SMTP id w14csp549751vqr; Sat, 5 Aug 2023 09:59:50 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGLeWzSm9h5+GW0zl4ebiLEzz2lPC9MeWJpotjO0MbTEtfl2GV3Dh9YM8DRI87o//rIGRmy X-Received: by 2002:a05:6a20:8f24:b0:13f:bc16:c34e with SMTP id b36-20020a056a208f2400b0013fbc16c34emr4419132pzk.41.1691254789812; Sat, 05 Aug 2023 09:59:49 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1691254789; cv=none; d=google.com; s=arc-20160816; b=1Ldx5F4UkjSoMeWwLmfRwPffIxmb2/m5KA8x68XeinTv5EGD1j20XDqQjVWS338mht YGwPvzZZJv/rG/GzUWZmSJt3TZhHiIhqWKElNhABGAJe0XVKg/dZna5VOswC0ykAfjfG Jn5xdmCBUGp0kMW/mjnN8yW8AKt2ERuPX3PwdI3cJBjggODgxbuHtMEBm0yeIPotargH giOuPALgBCJLYk/YuRWw0gI1jRBz1lVIe435Y0OjCRDK86nWQaDgsM8gih5pVlEs7PTj YQ59fY2qP4VCpokPLG67mbsw+Amf5FeD1m3isvrhb+rSR1Cd5RRi+qIcjpqFBbskfdP/ XXzw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:in-reply-to:content-disposition:mime-version :references:message-id:subject:to:from:date; bh=X/V71hWhLQJvehOt1f8G0nQ4xIL80C1PJus8vSR+UuU=; fh=WrF5P4rt5GKLKZXFPrBfHwP5VFIZG8GPN/h4vsvn4l4=; b=O+CpmZI3qTQtf3IVUC7tqc4+FE4tOZR2dynwSVarfmjOGYuJozGxhQOQE20cNRawie OTwDAN4R9N4mDK33ukGJxCK/TBy+qNpAsWg12L6n8JhoytqxcVvMCYiWQqxFcX5YoGoJ ufV76hQJiHUOWzcTRMdfkaEkA82tSoiW5F9aOl50p+sSv7l6xC8vj78UoF4hZrnasTkI QdknsbvX4L0mMYGl36H/7u3VxQLGxw+jypm08FsuKP5QyBZPnYGvxpJfJoNWC7hMQQeV gfzsS8Vtvv/OJ809O3qHd1nNKrOEu8wYRbIBxA2L6PU/DO+EmBLNAXBFhb8wPrC8iK4j P9gA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id z16-20020a056a001d9000b0067f69d10241si3306787pfw.176.2023.08.05.09.59.37; Sat, 05 Aug 2023 09:59:49 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229456AbjHEQX0 (ORCPT + 99 others); Sat, 5 Aug 2023 12:23:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37568 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229627AbjHEQXY (ORCPT ); Sat, 5 Aug 2023 12:23:24 -0400 Received: from pidgin.makrotopia.org (pidgin.makrotopia.org [185.142.180.65]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D9CC1103 for ; Sat, 5 Aug 2023 09:23:23 -0700 (PDT) Received: from local by pidgin.makrotopia.org with esmtpsa (TLS1.3:TLS_AES_256_GCM_SHA384:256) (Exim 4.96) (envelope-from ) id 1qSK3i-0000dH-1f; Sat, 05 Aug 2023 16:23:18 +0000 Date: Sat, 5 Aug 2023 17:23:11 +0100 From: Daniel Golle To: Randy Dunlap , Richard Weinberger , Miquel Raynal , Vignesh Raghavendra , linux-kernel@vger.kernel.org, linux-mtd@lists.infradead.org Subject: [PATCH v2 1/7] mtd: ubi: improve Kconfig formatting Message-ID: <62240f36e4838e925e32add167a2d7d201843b0d.1691252291.git.daniel@makrotopia.org> References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1773409182464670102 X-GMAIL-MSGID: 1773409182464670102 Kconfig help text should be indented with one tab + 2 spaces according to coding-style.rst. Apply this rule in drivers/mtd/ubi/Kconfig Signed-off-by: Daniel Golle --- drivers/mtd/ubi/Kconfig | 60 ++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/drivers/mtd/ubi/Kconfig b/drivers/mtd/ubi/Kconfig index 2ed77b7b3fcb5..184118f9a2969 100644 --- a/drivers/mtd/ubi/Kconfig +++ b/drivers/mtd/ubi/Kconfig @@ -61,47 +61,47 @@ config MTD_UBI_FASTMAP bool "UBI Fastmap (Experimental feature)" default n help - Important: this feature is experimental so far and the on-flash - format for fastmap may change in the next kernel versions - - Fastmap is a mechanism which allows attaching an UBI device - in nearly constant time. Instead of scanning the whole MTD device it - only has to locate a checkpoint (called fastmap) on the device. - The on-flash fastmap contains all information needed to attach - the device. Using fastmap makes only sense on large devices where - attaching by scanning takes long. UBI will not automatically install - a fastmap on old images, but you can set the UBI module parameter - fm_autoconvert to 1 if you want so. Please note that fastmap-enabled - images are still usable with UBI implementations without - fastmap support. On typical flash devices the whole fastmap fits - into one PEB. UBI will reserve PEBs to hold two fastmaps. - - If in doubt, say "N". + Important: this feature is experimental so far and the on-flash + format for fastmap may change in the next kernel versions + + Fastmap is a mechanism which allows attaching an UBI device + in nearly constant time. Instead of scanning the whole MTD device it + only has to locate a checkpoint (called fastmap) on the device. + The on-flash fastmap contains all information needed to attach + the device. Using fastmap makes only sense on large devices where + attaching by scanning takes long. UBI will not automatically install + a fastmap on old images, but you can set the UBI module parameter + fm_autoconvert to 1 if you want so. Please note that fastmap-enabled + images are still usable with UBI implementations without + fastmap support. On typical flash devices the whole fastmap fits + into one PEB. UBI will reserve PEBs to hold two fastmaps. + + If in doubt, say "N". config MTD_UBI_GLUEBI tristate "MTD devices emulation driver (gluebi)" help - This option enables gluebi - an additional driver which emulates MTD - devices on top of UBI volumes: for each UBI volumes an MTD device is - created, and all I/O to this MTD device is redirected to the UBI - volume. This is handy to make MTD-oriented software (like JFFS2) - work on top of UBI. Do not enable this unless you use legacy - software. + This option enables gluebi - an additional driver which emulates MTD + devices on top of UBI volumes: for each UBI volumes an MTD device is + created, and all I/O to this MTD device is redirected to the UBI + volume. This is handy to make MTD-oriented software (like JFFS2) + work on top of UBI. Do not enable this unless you use legacy + software. config MTD_UBI_BLOCK bool "Read-only block devices on top of UBI volumes" default n depends on BLOCK help - This option enables read-only UBI block devices support. UBI block - devices will be layered on top of UBI volumes, which means that the - UBI driver will transparently handle things like bad eraseblocks and - bit-flips. You can put any block-oriented file system on top of UBI - volumes in read-only mode (e.g., ext4), but it is probably most - practical for read-only file systems, like squashfs. + This option enables read-only UBI block devices support. UBI block + devices will be layered on top of UBI volumes, which means that the + UBI driver will transparently handle things like bad eraseblocks and + bit-flips. You can put any block-oriented file system on top of UBI + volumes in read-only mode (e.g., ext4), but it is probably most + practical for read-only file systems, like squashfs. - When selected, this feature will be built in the UBI driver. + When selected, this feature will be built in the UBI driver. - If in doubt, say "N". + If in doubt, say "N". endif # MTD_UBI