From patchwork Sat Dec 17 02:09:40 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Cournoyer X-Patchwork-Id: 45386 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id E678127BBEB; Sat, 17 Dec 2022 02:10:24 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-3.7 required=5.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,SPF_HELO_PASS autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 1B54527BBE9 for ; Sat, 17 Dec 2022 02:10:23 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1p6MeN-0003g2-46; Fri, 16 Dec 2022 21:10:07 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1p6MeK-0003fH-Td for guix-patches@gnu.org; Fri, 16 Dec 2022 21:10:05 -0500 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1p6MeJ-0005jT-3v for guix-patches@gnu.org; Fri, 16 Dec 2022 21:10:04 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1p6MeI-00042C-I1 for guix-patches@gnu.org; Fri, 16 Dec 2022 21:10:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#60135] [PATCH] doc: fix typos Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 17 Dec 2022 02:10:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 60135 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 60135@debbugs.gnu.org Cc: u-boot@lists.denx.de, Heinrich Schuchardt , Simon Glass , Maxim Cournoyer , Sudeep Holla X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.167124299315493 (code B ref -1); Sat, 17 Dec 2022 02:10:02 +0000 Received: (at submit) by debbugs.gnu.org; 17 Dec 2022 02:09:53 +0000 Received: from localhost ([127.0.0.1]:52975 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p6Me9-00041p-6Q for submit@debbugs.gnu.org; Fri, 16 Dec 2022 21:09:53 -0500 Received: from lists.gnu.org ([209.51.188.17]:44028) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p6Me5-00041j-6g for submit@debbugs.gnu.org; Fri, 16 Dec 2022 21:09:51 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1p6Me5-0003bi-1S for guix-patches@gnu.org; Fri, 16 Dec 2022 21:09:49 -0500 Received: from mail-qt1-x82a.google.com ([2607:f8b0:4864:20::82a]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1p6Me2-0005hn-Sw for guix-patches@gnu.org; Fri, 16 Dec 2022 21:09:48 -0500 Received: by mail-qt1-x82a.google.com with SMTP id j16so4222896qtv.4 for ; Fri, 16 Dec 2022 18:09:46 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=4f9vVU7biyi2tJOCD7AAf7GCOuKg+QL7XUXtI/sniJw=; b=ajvFq4piQNybiNHFQrrY2HjBiRn7beJlH0ZNNxX3q7Ur8xBqA3wgUwbnQRo+cDqlg9 n6TiQIjqbEr/KExEP9lXLTkD3XPV9+V9ou/BG59L4F9akvh6fF9tXLIWhMZtx/xm2a4u 3ibMj6cbzBSobsR80zHhd1IlG4aN0J76T5HV9A5867MwD/ELt6g92al/9Bh813bqGeB5 nMWo9jZJINHFISJ0mJnzRzRLWMJfOt8ZG1R7wBZqnI8zzLiATaUXYUCPel7zg+iEs2li IKfIf4bsQLjEnlWkAP570cNDfmQlRaMXD6osts2fBUjZbNGinbXfDOielKv8SZAnXJAf MSjg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=4f9vVU7biyi2tJOCD7AAf7GCOuKg+QL7XUXtI/sniJw=; b=3TNxiOmIWhEChxYlryeLZQNxzOyZjDEWoBFcccemJu7QLN4e+ruYlps1UIXJTp0pqx BwJUX8tENaNhpN49qib807fuL1UrQlOFBj3aZsGmkDdi2C8LN5F6f0BRXau/3yyzqrCX D7b3cr56mTUhAFAbjLbaot8bUqMj9n6YYSJtGoFE0NApArHE+2Pvr5CYpV4dyxee7ci0 y5BsLbWGYEVcsNaQjSeOlN2e0Q51X1f1+tVtV9YY1ZAREbMIND7uT9eXkrqNQYgpa9ut rsSh3dXPWUY97cc0k2v19H7djU6dWu27cipv5F3KPkMthW+7/o7UpzIMjwnD3ZwxGpRI UnqQ== X-Gm-Message-State: ANoB5pk+jJFUeFOeSkLF2/EPMIZtIoKm3Bha28Qni7nm0TI6Rm0OUQ4r IkQZ4EfRfr3QCRkklegTo7O3JbYyzIQELCY6 X-Google-Smtp-Source: AA0mqf51lMbfallny3ZSm7jmlkIvHq1Bww5JdyyjnEsUJAXkqpvjSVehk8J1RPua1TAqvEXf+fBhkw== X-Received: by 2002:ac8:765a:0:b0:3a7:e0ba:7c23 with SMTP id i26-20020ac8765a000000b003a7e0ba7c23mr45161787qtr.60.1671242985278; Fri, 16 Dec 2022 18:09:45 -0800 (PST) Received: from localhost.localdomain (dsl-159-157.b2b2c.ca. [66.158.159.157]) by smtp.gmail.com with ESMTPSA id r3-20020a05620a03c300b006eed75805a2sm2545959qkm.126.2022.12.16.18.09.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Dec 2022 18:09:44 -0800 (PST) From: Maxim Cournoyer X-Google-Original-From: Maxim Cournoyer Date: Fri, 16 Dec 2022 21:09:40 -0500 Message-Id: <20221217020940.31610-1-maxim.cournoyer@savoirfairelinux.com> X-Mailer: git-send-email 2.38.1 MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::82a; envelope-from=maxim.cournoyer@gmail.com; helo=mail-qt1-x82a.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches Fix a few typos spot during a first read of the contribution process. Signed-off-by: Maxim Cournoyer Reviewed-by: Heinrich Schuchardt --- doc/develop/process.rst | 4 ++-- doc/develop/sending_patches.rst | 6 +++--- doc/develop/system_configuration.rst | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) base-commit: 9bd3d354a1a0712ac27c717df9ad60566b0406ee diff --git a/doc/develop/process.rst b/doc/develop/process.rst index 0fa0143bf3..ba864bc40b 100644 --- a/doc/develop/process.rst +++ b/doc/develop/process.rst @@ -165,7 +165,7 @@ document. `_ and similar additional tags. -* Reviewed-by: The patch has been reviewed and found acceptible according to +* Reviewed-by: The patch has been reviewed and found acceptable according to the `Reveiwer's statement of oversight `_. A *Reviewed-by:* tag is a statement of opinion that the patch is an @@ -251,7 +251,7 @@ like this: workflows and environments however. #. Although a custodian is supposed to perform their own tests it is a - well-known and accepted fact that they needs help from other developers who + well-known and accepted fact that they need help from other developers who - for example - have access to the required hardware or other relevant environments. Custodians are expected to ask for assistance with testing when required. diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst index 173075687e..49374f14ff 100644 --- a/doc/develop/sending_patches.rst +++ b/doc/develop/sending_patches.rst @@ -20,8 +20,8 @@ LWN article `How to Get Your Change Into the Linux Kernel Using patman ------------ -You can use a tool called patman to prepare, check and sent patches. It creates -change logs, cover letters and patch notes. It also simplified the process of +You can use a tool called patman to prepare, check and send patches. It creates +change logs, cover letters and patch notes. It also simplifies the process of sending multiple versions of a series. See more details at :doc:`patman`. @@ -312,7 +312,7 @@ Notes 2. All code must follow the :doc:`codingstyle` requirements. 3. Before sending the patch, you *must* run some form of local testing. - Submitting a patch that does not build or function correct is a mistake. For + Submitting a patch that does not build or function correctly is a mistake. For non-trivial patches, either building a number of platforms locally or making use of :doc:`ci_testing` is strongly encouraged in order to avoid problems that can be found when attempting to merge the patch. diff --git a/doc/develop/system_configuration.rst b/doc/develop/system_configuration.rst index 52e4e1df15..40be46b082 100644 --- a/doc/develop/system_configuration.rst +++ b/doc/develop/system_configuration.rst @@ -86,12 +86,12 @@ When to use each mechanism ^^^^^^^^^^^^^^^^^^^^^^^^^^ While there are some cases where it should be fairly obvious where to use each -mechanism, as for example a command would done via Kconfig, a new I2C driver +mechanism, as for example a command would be done via Kconfig, a new I2C driver should use Kconfig and be configured via driver model and a header of values generated by an external tool should be ``CFG``, there will be cases where it's less clear and one needs to take care when implementing it. In general, configuration *options* should be done in Kconfig and configuration *settings* -should done in driver model or ``CFG``. Let us discuss things to keep in mind +should be done in driver model or ``CFG``. Let us discuss things to keep in mind when picking the appropriate mechanism. A thing to keep in mind is that we have a strong preference for using Kconfig as @@ -122,7 +122,7 @@ to use Kconfig in this case, it would result in using calculated rather than constructed values, resulting in less clear code. Consider the example of a set of register values for a memory controller. Defining this as a series of logical ORs and shifts based on other defines is more clear than the Kconfig entry that -set the calculated value alone. +sets the calculated value alone. When it has been determined that the practical solution is to utilize the ``CFG`` mechanism, the next decision is where to place these settings. It is