From patchwork Tue Nov 27 13:37:07 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrea Gelmini X-Patchwork-Id: 10700547 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 36FB514D6 for ; Tue, 27 Nov 2018 13:37:17 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 269532B3DC for ; Tue, 27 Nov 2018 13:37:17 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 1A6122B3EA; Tue, 27 Nov 2018 13:37:17 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.7 required=2.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 03E412B3C8 for ; Tue, 27 Nov 2018 13:37:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727453AbeK1AfL (ORCPT ); Tue, 27 Nov 2018 19:35:11 -0500 Received: from mail-qk1-f195.google.com ([209.85.222.195]:40233 "EHLO mail-qk1-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726920AbeK1AfL (ORCPT ); Tue, 27 Nov 2018 19:35:11 -0500 Received: by mail-qk1-f195.google.com with SMTP id y16so14530374qki.7 for ; Tue, 27 Nov 2018 05:37:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=RBFQZ3Jizzj0g9+Kkv91Rz/Y3Boy5d0DGpkk9TfbUPI=; b=ZqpfD7PgsIlyGBIqs0VVpc8naDUT3GInZ4D3V1LtUNC0Etg9Ldz3qU8dbsm2BURTuh 1nB9ZBB7oLVJvBEuFKXSwrR+GoMiiDaYpyQM+FDK9fLQVh5kH7ybiSRQOu2LsPbDLEfJ 6kctRNlLmLpr2/pPEEwusOPku/Wat3ShaVNVqD4Asen4d2cO4TerWg/1JleHdJk1jUdT SXDdg6hNfxPuMV6Q4uWQo20dl/0EG0wafxskYqvTnFgJI1L/0rdHQ2QcmJviGrOu8Pjo WN3beZ5DYwFQJYbGNIDLEQjgP8RtdtUzhFt9Nk87sz2yqyR3fdoqO6JAjJcjLHrQzyxx nK5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :mime-version:content-transfer-encoding; bh=RBFQZ3Jizzj0g9+Kkv91Rz/Y3Boy5d0DGpkk9TfbUPI=; b=ZXJn1+PL3O19Bbn66rbmEQ3GPapB5monwDd4Mf19DEMnPHC2TX7ITSj8UbJcISyxCV C7wZaAEXHIPbYxhc64OZuu6rBWtvnyGGwb4yiBu0TDyYhimfTcRPTcb88cn3Nr6gWiiw yqabTTPOFtWQNnvIvPxthBxwNcfnqxtEd942r6E1CqZW2DfymuYd/ZRfQ5gqg2plPLXG +HMw8pty9/uDNjBm3tlVA4jLXLqFkE6iat+WjFguZuP8+88fz6/9rNuwv6kzoqOVUawB zDVTh/eDezrYcPUHhmTODyFKg1+G+Q31Mz//W4hi6f+xmintOM5d41LrE0cs2c/O333U ImMA== X-Gm-Message-State: AA+aEWb7DzjgMiaLQ1iIcI59CBpSo3TwN6eSRYGvVVSJntja6oytWZWm J2I+Bo3i09s0nkeDrMQPts2m0edLoEQ= X-Google-Smtp-Source: AFSGD/XvtGdqXsfa5lYDVxE9pFyqa0GKCWJHL+MUG03FfA2Dihc4Ih6ZYQgOWV+BjFf7C78NxTptvQ== X-Received: by 2002:a37:9e8e:: with SMTP id h136mr30738255qke.324.1543325832785; Tue, 27 Nov 2018 05:37:12 -0800 (PST) Received: from localhost.localdomain ([185.197.228.4]) by smtp.gmail.com with ESMTPSA id 32sm2340725qto.55.2018.11.27.05.37.11 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 27 Nov 2018 05:37:12 -0800 (PST) From: Andrea Gelmini To: linux-btrfs@vger.kernel.org Cc: Andrea Gelmini Subject: [PATCH] Fix typos in docs Date: Tue, 27 Nov 2018 14:37:07 +0100 Message-Id: <20181127133707.20323-1-andrea.gelmini@gelma.net> X-Mailer: git-send-email 2.20.0.rc1.28.g8a4ee09a8a MIME-Version: 1.0 Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Signed-off-by: Andrea Gelmini --- Documentation/DocConventions | 4 ++-- Documentation/ReleaseChecklist | 4 ++-- Documentation/btrfs-man5.asciidoc | 8 ++++---- Documentation/btrfs-property.asciidoc | 2 +- Documentation/btrfs-qgroup.asciidoc | 4 ++-- Documentation/mkfs.btrfs.asciidoc | 2 +- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/DocConventions b/Documentation/DocConventions index e84ed7a..969209c 100644 --- a/Documentation/DocConventions +++ b/Documentation/DocConventions @@ -23,7 +23,7 @@ Quotation in subcommands: - command reference: bold *btrfs fi show* - section references: italics 'EXAMPLES' -- argument name in option desciption: caps in angle brackets +- argument name in option description: caps in angle brackets - reference in help text: caps NAME also possible: caps italics 'NAME' @@ -34,6 +34,6 @@ Quotation in subcommands: - optional parameter with argument: [-p ] -Refrences: +References: - full asciidoc syntax: http://asciidoc.org/userguide.html - cheatsheet: http://powerman.name/doc/asciidoc diff --git a/Documentation/ReleaseChecklist b/Documentation/ReleaseChecklist index d8bf50c..7fdbddf 100644 --- a/Documentation/ReleaseChecklist +++ b/Documentation/ReleaseChecklist @@ -4,7 +4,7 @@ Release checklist Last code touches: * make the code ready, collect patches queued for the release -* look to mailinglist for any relevant last-minute fixes +* look to mailin glist for any relevant last-minute fixes Pre-checks: @@ -31,7 +31,7 @@ Release: Post-release: -* write and send announcement mail to mailinglist +* write and send announcement mail to mailing list * update wiki://Main_page#News * update wiki://Changelog#btrfs-progs * update title on IRC diff --git a/Documentation/btrfs-man5.asciidoc b/Documentation/btrfs-man5.asciidoc index 448710a..c358cef 100644 --- a/Documentation/btrfs-man5.asciidoc +++ b/Documentation/btrfs-man5.asciidoc @@ -156,7 +156,7 @@ under 'nodatacow' are also set the NOCOW file attribute (see `chattr`(1)). NOTE: If 'nodatacow' or 'nodatasum' are enabled, compression is disabled. + Updates in-place improve performance for workloads that do frequent overwrites, -at the cost of potential partial writes, in case the write is interruted +at the cost of potential partial writes, in case the write is interrupted (system crash, device failure). *datasum*:: @@ -171,7 +171,7 @@ corresponding file attribute (see `chattr`(1)). NOTE: If 'nodatacow' or 'nodatasum' are enabled, compression is disabled. + There is a slight performance gain when checksums are turned off, the -correspoinding metadata blocks holding the checksums do not need to updated. +corresponding metadata blocks holding the checksums do not need to updated. The cost of checksumming of the blocks in memory is much lower than the IO, modern CPUs feature hardware support of the checksumming algorithm. @@ -185,7 +185,7 @@ missing, for example if a stripe member is completely missing from RAID0. Since 4.14, the constraint checks have been improved and are verified on the chunk level, not an the device level. This allows degraded mounts of filesystems with mixed RAID profiles for data and metadata, even if the -device number constraints would not be satisfied for some of the prifles. +device number constraints would not be satisfied for some of the profiles. + Example: metadata -- raid1, data -- single, devices -- /dev/sda, /dev/sdb + @@ -649,7 +649,7 @@ inherent limit of btrfs is 2^64^ (16 EiB) but the linux VFS limit is 2^63^ (8 Ei maximum number of subvolumes:: 2^64^ but depends on the available metadata space, the space consumed by all -subvolume metadata includes bookeeping of the shared extents can be large (MiB, +subvolume metadata includes bookkeeping of the shared extents can be large (MiB, GiB) maximum number of hardlinks of a file in a directory:: diff --git a/Documentation/btrfs-property.asciidoc b/Documentation/btrfs-property.asciidoc index b562717..4bad88b 100644 --- a/Documentation/btrfs-property.asciidoc +++ b/Documentation/btrfs-property.asciidoc @@ -34,7 +34,7 @@ specify what type of object you meant. This is only needed when a property could be set for more then one object type. + Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]', where -the first lettes is a shortcut. +the first letter is a shortcut. + Set the name of property by 'name'. If no 'name' is specified, all properties for the given object are printed. 'name' is one of diff --git a/Documentation/btrfs-qgroup.asciidoc b/Documentation/btrfs-qgroup.asciidoc index dff0867..dc4c93b 100644 --- a/Documentation/btrfs-qgroup.asciidoc +++ b/Documentation/btrfs-qgroup.asciidoc @@ -52,7 +52,7 @@ assignment would lead to quota inconsistency. See 'QUOTA RESCAN' for more information. --no-rescan:::: Explicitly ask not to do a rescan, even if the assignment will make the quotas -inconsitent. This may be useful for repeated calls where the rescan would add +inconsistent. This may be useful for repeated calls where the rescan would add unnecessary overhead. *create* :: @@ -140,7 +140,7 @@ force sync of the filesystem identified by before getting information. QUOTA RESCAN ------------ -The rescan reads all extent sharing metadata and updates the respective qgoups +The rescan reads all extent sharing metadata and updates the respective qgroups accordingly. The information consists of bytes owned exclusively ('excl') or shared/referred diff --git a/Documentation/mkfs.btrfs.asciidoc b/Documentation/mkfs.btrfs.asciidoc index 2a1c359..84e9cc0 100644 --- a/Documentation/mkfs.btrfs.asciidoc +++ b/Documentation/mkfs.btrfs.asciidoc @@ -314,7 +314,7 @@ layer between the logical and physical view of the device. The data lifetime may be affected by frequent plugging. The memory cells could get damaged, hopefully not destroying both copies of particular data in case of DUP. -The wear levelling techniques can also lead to reduced redundancy, even if the +The wear leveling techniques can also lead to reduced redundancy, even if the device does not do any deduplication. The controllers may put data written in a short timespan into the same physical storage unit (cell, block etc). In case this unit dies, both copies are lost. BTRFS does not add any artificial delay