From patchwork Tue Jun 15 14:11:09 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12321861 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 791A8C49361 for ; Tue, 15 Jun 2021 14:11:37 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 5B46C6140B for ; Tue, 15 Jun 2021 14:11:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231531AbhFOONk (ORCPT ); Tue, 15 Jun 2021 10:13:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36336 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231442AbhFOONX (ORCPT ); Tue, 15 Jun 2021 10:13:23 -0400 Received: from mail-wm1-x334.google.com (mail-wm1-x334.google.com [IPv6:2a00:1450:4864:20::334]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D1A3BC0613A3 for ; Tue, 15 Jun 2021 07:11:16 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id y13-20020a1c4b0d0000b02901c20173e165so2140534wma.0 for ; Tue, 15 Jun 2021 07:11:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=Q16gBMT1huu7BpCLhZyKDo4zDdTUuJLRUUVAFhN68bY=; b=sU/xWnUDHzDXuukPhdcHRoNhQHEmEM+cGQdhuLpfnYjjCAOmODOTDFhMB1aiMl3ChC KKosgJVMuzxaJ2j5ISdymDDPpp8Wyu1K2Fl0kfXup6neOxs+2OpKnIs25wOUADV/pSBX xbjgom+3BPnGTqv12DFNBYSjvlo/lpj53ujkHDFax5Rv5xbjiiwWrb+OZFKiM5UZHxhY 10wXPQzfxDP0cOeoWmvCkpV2l5toFqR07MHupIaaKx1A5H2gI7oSyvO0i5iAE51jpDsq ukZ5J5Pdlsbd4Pad7tkeXHubGyixyGB87tnVYt1jFMlhviKrl4xR4CO2CBGbqzD3Nzsi jULw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=Q16gBMT1huu7BpCLhZyKDo4zDdTUuJLRUUVAFhN68bY=; b=YgTkQAvyG320EE7dhkZRdyKxMnxOHDxudeid+DvTbPi6ESdsxi18JW6Zs+pdtK2GWM cfxrpam1udsBrQFEiHbpueeh07Tar7iw2TMTHhAJkYVW1UbVLGc7SS50GUOW4hRbcuG7 NajZmkx8G2RCeI600dcDvA/CqES57Lqraab/RJh/5TTW07QOtVTcPZcBGzCfxjalrVFh YIM5qcgEnAoqdC2HQ+/S0TgctqTnKALSgXGT7L7Bw+HEGTeaHRsgpmbQ+vyADIFq9r/j E9C4yRxxprsFuSqMwGmAb0JdOUTr6ELvDzgpKDGaVX5m9/pcue1vg7PKwHVoGRwktsrd 9ywA== X-Gm-Message-State: AOAM53128e4CLy0qjprTKj17C2ssKAu3LMYokmnoXqh4QcIDGXiSINNa rqPJlKeI6lE0is5MAhhdKvuAIhv6KQM= X-Google-Smtp-Source: ABdhPJwl2qYjqC7CzplVT9/aBM7h961EdgYnkmkqxu+Uchn4oNwBlrAS9J79RuYk6HIBOHvg42tO0g== X-Received: by 2002:a7b:c1c5:: with SMTP id a5mr23369408wmj.134.1623766275503; Tue, 15 Jun 2021 07:11:15 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p6sm19897297wrf.51.2021.06.15.07.11.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Jun 2021 07:11:15 -0700 (PDT) Message-Id: <5b942776bb0af2e5d697904a67d6d489bdaf6d2e.1623766273.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 15 Jun 2021 14:11:09 +0000 Subject: [PATCH v3 1/4] doc: avoid using the gender of other people Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, sandals@crustytoothpaste.net, stolee@gmail.com, jrnieder@gmail.com, emilyshaffer@google.com, =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7A=?= Bjarmason , Andrei Rybak , Felipe Contreras , Robert Karszniewicz , Jeff King , "Kerry, Richard" , Phillip Susi , Johannes Schindelin , Bagas Sanjaya , Derrick Stolee , Felipe Contreras Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Felipe Contreras From: Felipe Contreras Using gendered pronouns for an anonymous person applies a gender where none is known and further excludes readers who do not use gendered pronouns. Avoid such examples in the documentation by using "they" or passive voice to avoid the need for a pronoun. Inspired-by: Derrick Stolee Signed-off-by: Felipe Contreras Signed-off-by: Derrick Stolee --- Documentation/SubmittingPatches | 5 ++--- Documentation/git-push.txt | 4 ++-- Documentation/user-manual.txt | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 55287d72e0ef..3e215f4d8085 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -373,9 +373,8 @@ If you like, you can put extra tags at the end: . `Acked-by:` says that the person who is more familiar with the area the patch attempts to modify liked the patch. . `Reviewed-by:`, unlike the other tags, can only be offered by the - reviewer and means that she is completely satisfied that the patch - is ready for application. It is usually offered only after a - detailed review. + reviewers themselves when they are completely satisfied with the + patch after a detailed analysis. . `Tested-by:` is used to indicate that the person applied the patch and found it to have the desired effect. diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index a953c7c38790..2f25aa3a291b 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -244,8 +244,8 @@ Imagine that you have to rebase what you have already published. You will have to bypass the "must fast-forward" rule in order to replace the history you originally published with the rebased history. If somebody else built on top of your original history while you are -rebasing, the tip of the branch at the remote may advance with her -commit, and blindly pushing with `--force` will lose her work. +rebasing, the tip of the branch at the remote may advance with their +commit, and blindly pushing with `--force` will lose their work. + This option allows you to say that you expect the history you are updating is what you rebased and want to replace. If the remote ref diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index f9e54b867417..96240598e3f5 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -2792,7 +2792,7 @@ A fast-forward looks something like this: In some cases it is possible that the new head will *not* actually be a descendant of the old head. For example, the developer may have -realized she made a serious mistake, and decided to backtrack, +realized a serious mistake was made and decided to backtrack, resulting in a situation like: ................................................ From patchwork Tue Jun 15 14:11:10 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12321859 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A741BC48BE5 for ; Tue, 15 Jun 2021 14:11:36 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7DEB3613DA for ; Tue, 15 Jun 2021 14:11:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231522AbhFOONj (ORCPT ); Tue, 15 Jun 2021 10:13:39 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36338 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231307AbhFOONX (ORCPT ); Tue, 15 Jun 2021 10:13:23 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 95288C0613A4 for ; Tue, 15 Jun 2021 07:11:17 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id q5so18545751wrm.1 for ; Tue, 15 Jun 2021 07:11:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:mime-version :content-transfer-encoding:fcc:to:cc; bh=Dw1HJSLJAyxT+7lYCLicwFIMmj5JMWgxMnTQoyremeE=; b=QgHpDGtHOdzp7Sclwy4Z8FV+mRll1HLL+kyVobeVdvTQDUM1ia0b3jfXEu8Z3WzFqS GBsqbZEvKGGlEHEZSUYCITRTOh+NWSge8pk5l3sTjhTTGvv10csc2UhD+zjSaQ+hOy8c hzWeUgW2CDrjMkac2XNh0uF2z6ocGF5ifVYJKcTFEO8mfIexJ2kgwaHw8x4lRskcLrPn w4/RhCDuIgq+XfncYInCpBJlJDe4QOSMjUvkwFvkwF12WfhcDz4VK+MmPIRwIP7Ddlj1 P/DOI/Hc7ocbS0aaU5EJACwhdBprAEhrGRY//9I0Gb0JnmWsRMJXhlRFoUWX6vowrURQ U3iw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:mime-version:content-transfer-encoding:fcc:to:cc; bh=Dw1HJSLJAyxT+7lYCLicwFIMmj5JMWgxMnTQoyremeE=; b=NXyyEnZLk9qpIuNR5QMegwwJeM6gL2U534/1vyK6DuSd+axjIwgHWC00VsL7ZrvTzc y+yUT+Vcs33dv1FJjsFf7016nLolrH6Ef0JqDZ+X+eHb5g8tO8PuY4u/z2coS4mT8HOe cE2VbPZfjz7Vs5KMJujpqixN0uroSHzFnNR4QYb+ccdhS9hcETVIGbNKaG539RReDgc6 yP0o+u62TZoyfkJkXva0blYql5qYGIN4oALaICyCWwlutIcwuZFASdlmwjeQs4QzCpas 0BpwaHuK+4RzrD2g9KAra4CdOByqZXqA0gYvw2+hF2krr/hLkYE1A8LqZVsxLV2fvdBe aPbg== X-Gm-Message-State: AOAM530ZPeqpwbRoXBbmSw//RKnEJvEGWwDgH3u9Rut63zTjuuH/2o3g pHr9ZeQLNf9U3X5VjvSqrrH4CBiVkMM= X-Google-Smtp-Source: ABdhPJzy7ItDXLK7sjVyOVuMzR2aONH2DeNyAqrW7zKR8sowyuko5paTu/k4Tj5caWsDT93C6fxNWw== X-Received: by 2002:adf:e38e:: with SMTP id e14mr3400433wrm.384.1623766276162; Tue, 15 Jun 2021 07:11:16 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 89sm19704565wrq.14.2021.06.15.07.11.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Jun 2021 07:11:15 -0700 (PDT) Message-Id: <57d8486ab7c842842ca95fb51437ff7a1d693481.1623766273.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 15 Jun 2021 14:11:10 +0000 Subject: [PATCH v3 2/4] comments: avoid using the gender of our users MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: gitster@pobox.com, sandals@crustytoothpaste.net, stolee@gmail.com, jrnieder@gmail.com, emilyshaffer@google.com, =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7A=?= Bjarmason , Andrei Rybak , Felipe Contreras , Robert Karszniewicz , Jeff King , "Kerry, Richard" , Phillip Susi , Johannes Schindelin , Bagas Sanjaya , Derrick Stolee , Felipe Contreras Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Felipe Contreras From: Felipe Contreras We generally avoid specifying the gender of our users in order to be more inclusive, but sometimes a few slip by due to habit. Since by doing a little bit of rewording we can avoid this irrelevant detail, let's do so. Inspired-by: Derrick Stolee Helped-by: Ævar Arnfjörð Bjarmason Signed-off-by: Felipe Contreras Signed-off-by: Derrick Stolee --- commit.c | 2 +- config.h | 4 ++-- date.c | 2 +- pathspec.h | 2 +- strbuf.h | 4 ++-- wt-status.c | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/commit.c b/commit.c index 8ea55a447fa9..143f472c0f24 100644 --- a/commit.c +++ b/commit.c @@ -1178,7 +1178,7 @@ static void handle_signed_tag(struct commit *parent, struct commit_extra_header /* * We could verify this signature and either omit the tag when * it does not validate, but the integrator may not have the - * public key of the signer of the tag he is merging, while a + * public key of the signer of the tag being merged, while a * later auditor may have it while auditing, so let's not run * verify-signed-buffer here for now... * diff --git a/config.h b/config.h index 9038538ffdcb..a2200f311156 100644 --- a/config.h +++ b/config.h @@ -450,8 +450,8 @@ void git_configset_init(struct config_set *cs); /** * Parses the file and adds the variable-value pairs to the `config_set`, * dies if there is an error in parsing the file. Returns 0 on success, or - * -1 if the file does not exist or is inaccessible. The user has to decide - * if he wants to free the incomplete configset or continue using it when + * -1 if the file does not exist or is inaccessible. The caller decides + * whether to free the incomplete configset or continue using it when * the function returns -1. */ int git_configset_add_file(struct config_set *cs, const char *filename); diff --git a/date.c b/date.c index f9ea807b3a9f..c55ea47e96ad 100644 --- a/date.c +++ b/date.c @@ -908,7 +908,7 @@ int parse_expiry_date(const char *date, timestamp_t *timestamp) /* * We take over "now" here, which usually translates * to the current timestamp. This is because the user - * really means to expire everything she has done in + * really means to expire everything that was done in * the past, and by definition reflogs are the record * of the past, and there is nothing from the future * to be kept. diff --git a/pathspec.h b/pathspec.h index fceebb876f7a..2341dc990102 100644 --- a/pathspec.h +++ b/pathspec.h @@ -108,7 +108,7 @@ struct pathspec { * * A similar process is applied when a new pathspec magic is added. The designer * lifts the GUARD_PATHSPEC restriction in the functions that support the new - * magic. At the same time (s)he has to make sure this new feature will be + * magic while at the same time making sure this new feature will be * caught at parse_pathspec() in commands that cannot handle the new magic in * some cases. grepping parse_pathspec() should help. */ diff --git a/strbuf.h b/strbuf.h index 223ee2094af8..a86dcaaf44d1 100644 --- a/strbuf.h +++ b/strbuf.h @@ -337,8 +337,8 @@ const char *strbuf_join_argv(struct strbuf *buf, int argc, * placeholder is unknown, then the percent sign is copied, too. * * In order to facilitate caching and to make it possible to give - * parameters to the callback, `strbuf_expand()` passes a context pointer, - * which can be used by the programmer of the callback as she sees fit. + * parameters to the callback, `strbuf_expand()` passes a context + * pointer with any kind of data. */ typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, diff --git a/wt-status.c b/wt-status.c index 42b673571696..ebc0c0da1a84 100644 --- a/wt-status.c +++ b/wt-status.c @@ -639,7 +639,7 @@ static void wt_status_collect_changes_index(struct wt_status *s) * mode by passing a command line option we do not ignore any * changed submodule SHA-1s when comparing index and HEAD, no * matter what is configured. Otherwise the user won't be - * shown any submodules she manually added (and which are + * shown any submodules manually added (and which are * staged to be committed), which would be really confusing. */ handle_ignore_submodules_arg(&rev.diffopt, "dirty"); From patchwork Tue Jun 15 14:11:11 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 12321863 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3E07DC48BDF for ; Tue, 15 Jun 2021 14:11:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 20B3061481 for ; Tue, 15 Jun 2021 14:11:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231543AbhFOONl (ORCPT ); Tue, 15 Jun 2021 10:13:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36340 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231332AbhFOONX (ORCPT ); Tue, 15 Jun 2021 10:13:23 -0400 Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2FE33C061280 for ; Tue, 15 Jun 2021 07:11:18 -0700 (PDT) Received: by mail-wr1-x42d.google.com with SMTP id f2so18511731wri.11 for ; Tue, 15 Jun 2021 07:11:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=5GBBqDj3sAlzQLzqWAxVV3AqolGMSjRBCtydTjbOBA0=; b=NulzNmQRp8gUwkUNJHJvvW0n9Jub1N7dgvRrWg24/DYbV0e50iNUympuOiXbn24PVs 27Xc19aqVLUMvF6w7Lw2dcjhI7Eky0/q+xXE+4xfGFk+Wy8zkmcK/1lxue7g2dvNoELx XXZh6QxXPkGQ2OzqI0LlzO0z/k6YO23GxbduXn6AfDas+gP9Sn5IQ+EOAoK8wXUyNDZ0 bxBXDTxLnDH4Pw/bm7gdhtaa0BK0mYrWlEX5bxSXouf87+Pf30XR5qCp2PBjfGIo8ixo Xh3frKtwXD0k2Tm6FRyXWLNG7TxaGbsQ7NPSbDNaAmbyzapwx/NLixrXp2KoXQ3RkGz8 B1Pw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=5GBBqDj3sAlzQLzqWAxVV3AqolGMSjRBCtydTjbOBA0=; b=JP5UzngyHbMVQppbesqc/DxHH9weC0uGjs9yrkuZWIQyQ/rSM9GNVSmsFwt9rOPaqd kgM2rSh4Af5X3SWLZ3HdLYgaUDusrhlzGLgEToO82L8PZUzSFqeODbZ8nKzUVRFVmV8a U5RAFj4Yb20T9Gn+wpc8kh9vEASVUSZ0FIy4CauKLAzVywzcv/aU25eRfPjDDCYZs43n S7i5cQ40PfLFqgx/IljH+z+3W2L1jwvCiHFGf9Uaux90jXMCNQuHw17PWrZiQ8sKNnRC AlQsGZQskolqiJRf+IqBn9Y02cAn98CiF4/Ak+1BQrfK9tQndlDUXKnaQMYKGhIr3jPt zYTg== X-Gm-Message-State: AOAM533EujGP1hXEb3omboEjFdw88XQohprzb4d4kazZtxRXSwryyk7Q yrYsz3okJmHSnUgHVYU4qr1aHRDXa7M= X-Google-Smtp-Source: ABdhPJzR+CNP5ifAlxZROto/Yb2K2EQpzRWpvMG2cm5zAE7D8Glmb1/AKJQxvs3Qgh+8lDjgPUwVsQ== X-Received: by 2002:a5d:48ce:: with SMTP id p14mr26003452wrs.170.1623766276840; Tue, 15 Jun 2021 07:11:16 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id z12sm18644216wrw.97.2021.06.15.07.11.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Jun 2021 07:11:16 -0700 (PDT) Message-Id: <6f6fa1b9466eceec053c4cd20e1e4c61063806da.1623766273.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 15 Jun 2021 14:11:11 +0000 Subject: [PATCH v3 3/4] *: fix typos Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, sandals@crustytoothpaste.net, stolee@gmail.com, jrnieder@gmail.com, emilyshaffer@google.com, =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7A=?= Bjarmason , Andrei Rybak , Felipe Contreras , Robert Karszniewicz , Jeff King , "Kerry, Richard" , Phillip Susi , Johannes Schindelin , Bagas Sanjaya , Derrick Stolee , Derrick Stolee Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Derrick Stolee From: Derrick Stolee These typos were found while searching the codebase for gendered pronouns. In the case of t9300-fast-import.sh, remove a confusing comment that is unnecessary to the understanding of the test. Signed-off-by: Derrick Stolee --- config.c | 2 +- t/t9300-fast-import.sh | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/config.c b/config.c index f9c400ad3062..7bb96f8f7124 100644 --- a/config.c +++ b/config.c @@ -2837,7 +2837,7 @@ static void maybe_remove_section(struct config_store_data *store, begin = store->parsed[i].begin; /* - * Next, make sure that we are removing he last key(s) in the section, + * Next, make sure that we are removing the last key(s) in the section, * and that there are no comments that are possibly about the current * section. */ diff --git a/t/t9300-fast-import.sh b/t/t9300-fast-import.sh index 5c47ac4465cb..7607ef65cb99 100755 --- a/t/t9300-fast-import.sh +++ b/t/t9300-fast-import.sh @@ -1538,7 +1538,6 @@ test_expect_success 'O: comments are all skipped' ' commit refs/heads/O1 # -- ignore all of this text committer $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL> $GIT_COMMITTER_DATE - # $GIT_COMMITTER_NAME has inserted here for his benefit. data < X-Patchwork-Id: 12321865 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 93557C49EA3 for ; Tue, 15 Jun 2021 14:11:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7FBFE6140B for ; Tue, 15 Jun 2021 14:11:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231575AbhFOONm (ORCPT ); Tue, 15 Jun 2021 10:13:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36346 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231159AbhFOONY (ORCPT ); Tue, 15 Jun 2021 10:13:24 -0400 Received: from mail-wm1-x336.google.com (mail-wm1-x336.google.com [IPv6:2a00:1450:4864:20::336]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E3B30C061283 for ; Tue, 15 Jun 2021 07:11:18 -0700 (PDT) Received: by mail-wm1-x336.google.com with SMTP id f16-20020a05600c1550b02901b00c1be4abso1879065wmg.2 for ; Tue, 15 Jun 2021 07:11:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=EYOgHRcT6a4KIPZZUBnzGlAboF/wgwCauIODRP17fH4=; b=JwU5OKeu13OLwu3wzK/pJKo/1qSlOIvEBPVmYkhqXqN91+9AYpqqSzTwYIkOB5lBsB Ifj3TRNQryu4YWMt30dNdrfRmEGswmtc/WQZ0KMU9hQ3IhnymM3acOvgePf77AqloObG ZYCIhOa8gUlEfoqNDXNuwow+fKcTnQqLdIVc441pB4JHwv+bf1STLvSMGFokYBzbqAWm beTxRgfN6ysHsU8zSzV0dGSYDT6UBu965NLKi8wHRB/KI8dPFnVrUscVDjCr/ml6b4zO g6XmJYMWFKz9PpyjGyFhZE8RtXNflFuwb26b+PoDtuhZQ3Wsjag6xYaGf/99hLlVG6LZ cnoQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=EYOgHRcT6a4KIPZZUBnzGlAboF/wgwCauIODRP17fH4=; b=n3CP38H2OU4XwDAztzr7qjjVEsgDuGuEXEIfJHSROnioPIji30AYR0gXjS/I1Uy7c2 8Hw1UhDNbXzsMTBWU/s0PUk/8awDsFlcupRXyNcXkcs3U297ofqFAYL9UcxGnwAN3BT8 ggyFuFE4zaPpJn3XbVSRYWpwv5WWJGjLzJbR8Ls/4QU1i0Oyv9izMAGQ8jZGJAskUpRh oZTJOLJIX2IXPS6Y2GB6GIW3RXow7cwKuKlyk+QCGAkEK6CoScXY6q6SX4kJaMuSvM04 RfkkwfQAab5pb8F0rZuvQwqTFFJHkikhul5AMHwbV5fI5FcUWvUxeZ0qsXa/BCFChcjP nu+A== X-Gm-Message-State: AOAM531K6WNyc1HWr7RSev3cx/psf5uWI22sYh01AVV6otqBJjq/ou7H fbo0y1lSrNWBSXJNZV4EbhUr5foJd8Y= X-Google-Smtp-Source: ABdhPJx3PHrKsiIRn4xPO5EhsX7y/EM8M+q07DT61+smLBvnMoxfhag/yrazUvjnUG8MxM9F7q+1Hw== X-Received: by 2002:a05:600c:4b88:: with SMTP id e8mr22473993wmp.107.1623766277491; Tue, 15 Jun 2021 07:11:17 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id y189sm16367815wmy.25.2021.06.15.07.11.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Jun 2021 07:11:17 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 15 Jun 2021 14:11:12 +0000 Subject: [PATCH v3 4/4] CodingGuidelines: recommend singular they Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: gitster@pobox.com, sandals@crustytoothpaste.net, stolee@gmail.com, jrnieder@gmail.com, emilyshaffer@google.com, =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7A=?= Bjarmason , Andrei Rybak , Felipe Contreras , Robert Karszniewicz , Jeff King , "Kerry, Richard" , Phillip Susi , Johannes Schindelin , Bagas Sanjaya , Derrick Stolee , Derrick Stolee Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Derrick Stolee From: Derrick Stolee Technical writing seeks to convey information with minimal friction. One way that a reader can experience friction is if they encounter a description of "a user" that is later simplified using a gendered pronoun. If the reader does not consider that pronoun to apply to them, then they can experience cognitive dissonance that removes focus from the information. When choosing a gendered pronoun, that pronoun no longer applies to nearly half of possible readers. Even if we alternated between "he/him" and "she/her" perfectly evenly, we would still expect male and female readers to experience an incorrect pronoun half the time. However, some readers will not prescribe to either of these binary genders. Those readers hence suffer an incorrect pronoun the entire time. To make our documentation more inclusive, add recommendations to the CodingGuidelines document. We can refer to this section when a contributor submits a patch with a gendered pronoun and these recommendations apply. The examples can assist in producing a new patch with adjusted language. As noted in the guidelines, removing an example person can make the writing clearer and more concise. Other techniques such as singular "you" and plural "they" are widely accepted ways to adjust the noun and avoid gendered pronouns. Finally, an author can resort to singluar "they" if absolutely necessary, but this can be difficult for readers who learned English in a way that dictated "they" as always plural. If we refer to a specific person, then using a gendered pronoun is appropriate. There can also be other cases where it is inappropriate for us to update the existing examples within the Git codebase, such as: * References to real people (e.g. Linus Torvalds, "the Git maintainer"). Do not misgender real people. If there is any doubt to the gender of a person, then avoid using pronouns. * References to fictional people with clear genders (e.g. Alice and Bob). * Sample text used in test cases (e.g t3702, t6432). * The official text of the GPL license contains uses of "he or she", but modifying the license this way is not within the scope of the Git project. * Literal email messages in Documentation/howto/ should not be edited for grammatical concerns such as this, unless we update the entire document to fit the standard documentation format. If such an effort is taken on, then the authorship would change and no longer refer to the exact mail message. * External projects consumed in contrib/ should not deviate solely for style reasons. Recommended edits should be contributed to those projects directly. Other cases within the Git project were cleaned up by the previous changes. Co-authored-by: Junio C Hamano Signed-off-by: Derrick Stolee --- Documentation/CodingGuidelines | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index e3af089ecf26..0282f836548a 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -551,6 +551,34 @@ Writing Documentation: documentation, please see the documentation-related advice in the Documentation/SubmittingPatches file). + In order to ensure the documentation is inclusive, avoid assuming + that an unspecified example person is male or female, and think + twice before using "he", "him", "she", or "her". Here are some + tips to avoid use of gendered pronouns: + + - Removing the example person might make the sentence more + clear and efficient. Instead of saying "The programmer + chooses between X and Y as she sees fit", it is clearer to + say "Valid choices are X and Y". + + - If you need to talk about an example person, then try using + second-person to allow the reader to be that example. For + example, "If you want X to happen, you'd pass option Y", + instead of "If the user wants X to happen, she'd ..."). + Alternatively, replace the single example with more than one + person and use plural "they", such as "Interested readers + can read 'git log -p README' to learn the history in their + ample spare time" instead of "an interested reader" learning + in "his" spare time). + + - If you absolutely need to refer to an example person that is + third-person singluar, you may resort to "singular they" (e.g. + "A contributor asks their upstream to pull from them"). Note + that this sounds ungrammatical and unnatural to those who + learned English as a second language in some parts of the + world, so should be avoided unless the earlier techniques + fail to improve the sentence. + Every user-visible change should be reflected in the documentation. The same general rule as for code applies -- imitate the existing conventions.