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: 1817323 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=none (no SPF record) smtp.mailfrom=lists.infradead.org (client-ip=2607:7c80:54:3::133; helo=bombadil.infradead.org; envelope-from=linux-mtd-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org; receiver=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; secure) header.d=lists.infradead.org header.i=@lists.infradead.org header.a=rsa-sha256 header.s=bombadil.20210309 header.b=GB9X13vp; dkim-atps=neutral Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4RJ7FH3yD5z1yZb for ; Sun, 6 Aug 2023 02:24:01 +1000 (AEST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:To:From:Date:Reply-To:Cc:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=XFMXMX77ASeC3Eg6jOYr5muecmi7miEW47r9rIKIt74=; b=GB9X13vpwfkvQW dAEgCn9vF7TTBKDLnT2C0vWH1K5t+UiukXrUDtQAlCimWM1j5FWUWWdW3Pc+CqlUi/DMawZZvuKeH vXlKCuXZy3oU8bPWPswLDsHE5SzKIDt0xRevkWLKRDxvYel6VYucBbVC2xZ3ztOWiCtdpkF2h1XLa eSTCV9/41sAZ18rMawRGgZvrUuQdDLbsAnZ6MIXCwtUaQDyc2jdo/7M//jSksz01xFlRMz2xyXP1u oxlTZku0DbFoNKgOTtikd01r+itpA6F0UBuNsiTkT2+bmJuQFnbRL2RQcLRnWcz+4kHZEpMROIFUi Dy4Fha+BkBmwQFxndpIg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qSK3s-00EKHK-2s; Sat, 05 Aug 2023 16:23:28 +0000 Received: from pidgin.makrotopia.org ([185.142.180.65]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1qSK3p-00EKGa-3D for linux-mtd@lists.infradead.org; Sat, 05 Aug 2023 16:23:27 +0000 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-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20230805_092326_035126_0A3356CB X-CRM114-Status: GOOD ( 18.38 ) X-Spam-Score: 0.0 (/) X-Spam-Report: Spam detection software, running on the system "bombadil.infradead.org", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: 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(-) Content analysis details: (0.0 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-BeenThere: linux-mtd@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Linux MTD discussion mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-mtd" Errors-To: linux-mtd-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org 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