From patchwork Thu Oct 5 09:00:51 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= X-Patchwork-Id: 13410095 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C6D49E92701 for ; Thu, 5 Oct 2023 14:07:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232088AbjJEOHn (ORCPT ); Thu, 5 Oct 2023 10:07:43 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47608 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232194AbjJEOGB (ORCPT ); Thu, 5 Oct 2023 10:06:01 -0400 Received: from mail.smrk.net (mail.smrk.net [IPv6:2001:19f0:6c01:2788:5400:4ff:fe27:adaa]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 981D79EC9 for ; Thu, 5 Oct 2023 02:02:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1696496530; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=FJMiDdQtuLfTGXR7JbG2Ly5Rb7R/EIosUDZYXtE/OmY=; b=ncKHRXXFJ68WEl/lEgrKhPVP6xjBWFOSx/fUw98p4mT85dPECtxdI2MaGKuenI/3Ry0fzd aThHsgkeXL5X5ZJ8h5e43ApqDipi/EP3y92PWxIO2H5LMe2lB79993gvd+rHHQcV3FUrsB hwZ0onNGpMcW9cxGuKgTzTKZuIv1vL6eYSIt6ry5YLkYHXMSriq7how7OUDnGenpvYsjoO tTTWsGk/6bsCSpSjoGesvsjRGtenK4KOXq8QAlZQ0rpUZS5/GA+z0bxdY7FBViQiwQSOD2 O3cm3MevQCoYMe03ymIeSzfDiZZMWUa8eGJ+c2FGUUocXxXRZpM1ToSfoWL2Dg== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id 7e3867b1 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Thu, 5 Oct 2023 11:02:10 +0200 (CEST) From: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= To: git@vger.kernel.org Cc: Eric Sunshine , Junio C Hamano Subject: [PATCH v2 1/5] doc: fix some typos, grammar and wording issues Date: Thu, 5 Oct 2023 11:00:51 +0200 Message-ID: <20231005090055.3097783-1-stepnem@smrk.net> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231003082107.3002173-1-stepnem@smrk.net> References: <20231003082107.3002173-1-stepnem@smrk.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Signed-off-by: Štěpán Němec --- v2: Feedback from Eric and Junio, implement most of Eric's suggestions. Range-diff with two inline comments follows: 1: 2ab1bdb9a999 ! 1: 6c2766f9471f Fix some typos, grammar or wording issues in the documentation @@ Metadata Author: Štěpán Němec ## Commit message ## - Fix some typos, grammar or wording issues in the documentation + doc: fix some typos, grammar and wording issues ## Documentation/SubmittingPatches ## @@ Documentation/SubmittingPatches: mailing list{security-ml}, instead of the public mailing list. @@ Documentation/SubmittingPatches: help you find out who they are. [[patch-status]] + ## Documentation/config/transfer.txt ## +@@ Documentation/config/transfer.txt: exposure, e.g. because: + system. + * The git programs will pass the full URL to one another as arguments + on the command-line, meaning the credentials will be exposed to other +- users on OS's or systems that allow other users to see the full ++ unprivileged users on systems that allow them to see the full + process list of other users. On linux the "hidepid" setting + documented in procfs(5) allows for configuring this behavior. + + + Another "OS's" missed in v1, plus an attempt to fix the triple "other users" in a single sentence. ## Documentation/diff-options.txt ## @@ Documentation/diff-options.txt: ifndef::git-format-patch[] @@ Documentation/git.txt: foo.bar= ...`) sets `foo.bar` to the empty string which ` + This is useful for cases where you want to pass transitory -configuration options to git, but are doing so on OS's where -+configuration options to git, but are doing so on OSes where - other processes might be able to read your cmdline - (e.g. `/proc/self/cmdline`), but not your environ +-other processes might be able to read your cmdline +-(e.g. `/proc/self/cmdline`), but not your environ ++configuration options to git, but are doing so on operating systems ++where other processes might be able to read your command line ++(e.g. `/proc/self/cmdline`), but not your environment (e.g. `/proc/self/environ`). That behavior is the default on + Linux, but may not be on your system. + + ## Documentation/gitattributes.txt ## @@ Documentation/gitattributes.txt: will be stored via placeholder `%P`. @@ Documentation/gitattributes.txt: will be stored via placeholder `%P`. This attribute controls the length of conflict markers left in -the work tree file during a conflicted merge. Only setting to -+the work tree file during a conflicted merge. Only setting - the value to a positive integer has any meaningful effect. +-the value to a positive integer has any meaningful effect. ++the work tree file during a conflicted merge. Only a positive ++integer has a meaningful effect. For example, this line in `.gitattributes` can be used to tell the merge + machinery to leave much longer (instead of the usual 7-character-long) ## Documentation/giteveryday.txt ## @@ Documentation/giteveryday.txt: without a formal "merging". Or longhand + @@ Documentation/giteveryday.txt: without a formal "merging". Or longhand + ## contrib/README ## -@@ contrib/README: lesser degree various foreign SCM interfaces, so you know the +@@ contrib/README: This is the same way as how I have been treating gitk, and to a + lesser degree various foreign SCM interfaces, so you know the drill. - I expect that things that start their life in the contrib/ area --to graduate out of contrib/ once they mature, either by becoming -+graduate out of contrib/ once they mature, either by becoming +-I expect that things that start their life in the contrib/ area ++I expect things that start their life in the contrib/ area + to graduate out of contrib/ once they mature, either by becoming projects on their own, or moving to the toplevel directory. On the other hand, I expect I'll be proposing removal of disused - and inactive ones from time to time. +@@ contrib/README: and inactive ones from time to time. If you have new things to add to this area, please first propose it on the git mailing list, and after a list discussion proves @@ contrib/README: lesser degree various foreign SCM interfaces, so you know the audience -- for example I do not work with projects whose upstream is svn, so I have no use for git-svn myself, but it is + ## fsmonitor--daemon.h ## +@@ fsmonitor--daemon.h: struct fsmonitor_daemon_state { + * to only mean an external GITDIR referenced by a ".git" file. + * + * The platform FS event backends will receive watch-specific +- * relative paths (except for those OS's that always emit absolute ++ * relative paths (except for those OSes that always emit absolute + * paths). We use the following enum and routines to classify each + * path so that we know how to handle it. There is a slight asymmetry + * here because ".git/" is inside the working directory and the + Ended up only fixing the spelling here: expanding the abbreviation seemed unnecessarily intrusive given the context, and I'd say the abbreviation pragmatics is different in a header file compared to the main user-facing docs like git.txt above. ## strbuf.h ## @@ struct string_list; @@ t/README: The argument for --run, , is a list of description suite to include (or exclude, if negated) in the run. A range is two -numbers separated with a dash and matches a range of tests with both -ends been included. You may omit the first or the second number to -+numbers separated with a dash and matches an inclusive range of tests ++numbers separated with a dash and specifies an inclusive range of tests +to run. You may omit the first or the second number to mean "from the first test" or "up to the very last test" respectively. @@ t/README: This test harness library does the following things: -Here are some recommented styles when writing test case. - - Keep test title the same line with test helper function itself. -+ - Keep test titles and helper function invocations on the same line. ++ - Keep the test_expect_* function call and test title on ++ the same line. - Take test_expect_success helper for example, write it like: + For example, with test_expect_success, write it like: 2: 9c2c2b5f0574 = 2: 64bed10be547 doc/diff-options: improve wording of the log.diffMerges mention 3: 2636e1bf42ad = 3: fd8544c26690 git-jump: admit to passing merge mode args to ls-files 4: 5fa09b64efaf = 4: 42ee0a9b914a doc/gitk: s/sticked/stuck/ 5: 530abe377ad2 = 5: 23840e0368f1 t/README: fix multi-prerequisite example Documentation/SubmittingPatches | 10 +++++----- Documentation/config/transfer.txt | 2 +- Documentation/diff-options.txt | 2 +- Documentation/git-branch.txt | 2 +- Documentation/git-range-diff.txt | 2 +- Documentation/git.txt | 6 +++--- Documentation/gitattributes.txt | 4 ++-- Documentation/giteveryday.txt | 2 +- contrib/README | 4 ++-- fsmonitor--daemon.h | 2 +- strbuf.h | 8 ++++---- t/README | 31 +++++++++++++++---------------- 12 files changed, 37 insertions(+), 38 deletions(-) base-commit: d0e8084c65cbf949038ae4cc344ac2c2efd77415 diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 973d7a81d449..1259549cd488 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -393,8 +393,8 @@ mailing list{security-ml}, instead of the public mailing list. Learn to use format-patch and send-email if possible. These commands are optimized for the workflow of sending patches, avoiding many ways -your existing e-mail client that is optimized for "multipart/*" mime -type e-mails to corrupt and render your patches unusable. +your existing e-mail client (often optimized for "multipart/*" MIME +type e-mails) might render your patches unusable. People on the Git mailing list need to be able to read and comment on the changes you are submitting. It is important for @@ -515,8 +515,8 @@ repositories. git://git.ozlabs.org/~paulus/gitk - Those who are interested in improve gitk can volunteer to help Paul - in maintaining it cf. . + Those who are interested in improving gitk can volunteer to help Paul + maintain it, cf. . - `po/` comes from the localization coordinator, Jiang Xin: @@ -556,7 +556,7 @@ help you find out who they are. In any time between the (2)-(3) cycle, the maintainer may pick it up from the list and queue it to `seen`, in order to make it easier for -people play with it without having to pick up and apply the patch to +people to play with it without having to pick up and apply the patch to their trees themselves. [[patch-status]] diff --git a/Documentation/config/transfer.txt b/Documentation/config/transfer.txt index c3ac767d1e4d..1cbf477e5cfb 100644 --- a/Documentation/config/transfer.txt +++ b/Documentation/config/transfer.txt @@ -21,7 +21,7 @@ exposure, e.g. because: system. * The git programs will pass the full URL to one another as arguments on the command-line, meaning the credentials will be exposed to other - users on OS's or systems that allow other users to see the full + unprivileged users on systems that allow them to see the full process list of other users. On linux the "hidepid" setting documented in procfs(5) allows for configuring this behavior. + diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 35fae7c87c8a..ee256ec077be 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -301,7 +301,7 @@ ifndef::git-format-patch[] -z:: ifdef::git-log[] - Separate the commits with NULs instead of with new newlines. + Separate the commits with NULs instead of newlines. + Also, when `--raw` or `--numstat` has been given, do not munge pathnames and use NULs as output field terminators. diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index d207da9101a5..4395aa935438 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -324,7 +324,7 @@ superproject's "origin/main", but tracks the submodule's "origin/main". multiple times, in which case the last key becomes the primary key. The keys supported are the same as those in `git for-each-ref`. Sort order defaults to the value configured for the - `branch.sort` variable if exists, or to sorting based on the + `branch.sort` variable if it exists, or to sorting based on the full refname (including `refs/...` prefix). This lists detached HEAD (if present) first, then local branches and finally remote-tracking branches. See linkgit:git-config[1]. diff --git a/Documentation/git-range-diff.txt b/Documentation/git-range-diff.txt index 0b393715d707..6c728dbe44b2 100644 --- a/Documentation/git-range-diff.txt +++ b/Documentation/git-range-diff.txt @@ -166,7 +166,7 @@ A typical output of `git range-diff` would look like this: In this example, there are 3 old and 3 new commits, where the developer removed the 3rd, added a new one before the first two, and modified the -commit message of the 2nd commit as well its diff. +commit message of the 2nd commit as well as its diff. When the output goes to a terminal, it is color-coded by default, just like regular `git diff`'s output. In addition, the first line (adding a diff --git a/Documentation/git.txt b/Documentation/git.txt index 11228956cd5e..9aeabde26200 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -96,9 +96,9 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config to avoid ambiguity with `` containing one. + This is useful for cases where you want to pass transitory -configuration options to git, but are doing so on OS's where -other processes might be able to read your cmdline -(e.g. `/proc/self/cmdline`), but not your environ +configuration options to git, but are doing so on operating systems +where other processes might be able to read your command line +(e.g. `/proc/self/cmdline`), but not your environment (e.g. `/proc/self/environ`). That behavior is the default on Linux, but may not be on your system. + diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 6deb89a29677..8c1793c14880 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -1151,8 +1151,8 @@ will be stored via placeholder `%P`. ^^^^^^^^^^^^^^^^^^^^^^ This attribute controls the length of conflict markers left in -the work tree file during a conflicted merge. Only setting to -the value to a positive integer has any meaningful effect. +the work tree file during a conflicted merge. Only a positive +integer has a meaningful effect. For example, this line in `.gitattributes` can be used to tell the merge machinery to leave much longer (instead of the usual 7-character-long) diff --git a/Documentation/giteveryday.txt b/Documentation/giteveryday.txt index faba2ef0881c..f74a33fb35b9 100644 --- a/Documentation/giteveryday.txt +++ b/Documentation/giteveryday.txt @@ -229,7 +229,7 @@ without a formal "merging". Or longhand + git am -3 -k` An alternate participant submission mechanism is using the -`git request-pull` or pull-request mechanisms (e.g as used on +`git request-pull` or pull-request mechanisms (e.g. as used on GitHub (www.github.com) to notify your upstream of your contribution. diff --git a/contrib/README b/contrib/README index 05f291c1f1d3..21d3d0e7dee4 100644 --- a/contrib/README +++ b/contrib/README @@ -23,7 +23,7 @@ This is the same way as how I have been treating gitk, and to a lesser degree various foreign SCM interfaces, so you know the drill. -I expect that things that start their life in the contrib/ area +I expect things that start their life in the contrib/ area to graduate out of contrib/ once they mature, either by becoming projects on their own, or moving to the toplevel directory. On the other hand, I expect I'll be proposing removal of disused @@ -31,7 +31,7 @@ and inactive ones from time to time. If you have new things to add to this area, please first propose it on the git mailing list, and after a list discussion proves -there are some general interests (it does not have to be a +there is general interest (it does not have to be a list-wide consensus for a tool targeted to a relatively narrow audience -- for example I do not work with projects whose upstream is svn, so I have no use for git-svn myself, but it is diff --git a/fsmonitor--daemon.h b/fsmonitor--daemon.h index 70d776c54f6d..673f80d2aad0 100644 --- a/fsmonitor--daemon.h +++ b/fsmonitor--daemon.h @@ -99,7 +99,7 @@ struct fsmonitor_daemon_state { * to only mean an external GITDIR referenced by a ".git" file. * * The platform FS event backends will receive watch-specific - * relative paths (except for those OS's that always emit absolute + * relative paths (except for those OSes that always emit absolute * paths). We use the following enum and routines to classify each * path so that we know how to handle it. There is a slight asymmetry * here because ".git/" is inside the working directory and the diff --git a/strbuf.h b/strbuf.h index fd43c46433a4..e959caca876a 100644 --- a/strbuf.h +++ b/strbuf.h @@ -12,9 +12,9 @@ struct string_list; /** - * strbuf's are meant to be used with all the usual C string and memory + * strbufs are meant to be used with all the usual C string and memory * APIs. Given that the length of the buffer is known, it's often better to - * use the mem* functions than a str* one (memchr vs. strchr e.g.). + * use the mem* functions than a str* one (e.g., memchr vs. strchr). * Though, one has to be careful about the fact that str* functions often * stop on NULs and that strbufs may have embedded NULs. * @@ -24,7 +24,7 @@ struct string_list; * strbufs have some invariants that are very important to keep in mind: * * - The `buf` member is never NULL, so it can be used in any usual C - * string operations safely. strbuf's _have_ to be initialized either by + * string operations safely. strbufs _have_ to be initialized either by * `strbuf_init()` or by `= STRBUF_INIT` before the invariants, though. * * Do *not* assume anything on what `buf` really is (e.g. if it is @@ -37,7 +37,7 @@ struct string_list; * * - The `buf` member is a byte array that has at least `len + 1` bytes * allocated. The extra byte is used to store a `'\0'`, allowing the - * `buf` member to be a valid C-string. Every strbuf function ensure this + * `buf` member to be a valid C-string. All strbuf functions ensure this * invariant is preserved. * * NOTE: It is OK to "play" with the buffer directly if you work it this diff --git a/t/README b/t/README index 61080859899b..2ef89785f831 100644 --- a/t/README +++ b/t/README @@ -262,8 +262,8 @@ The argument for --run, , is a list of description substrings or globs or individual test numbers or ranges with an optional negation prefix (of '!') that define what tests in a test suite to include (or exclude, if negated) in the run. A range is two -numbers separated with a dash and matches a range of tests with both -ends been included. You may omit the first or the second number to +numbers separated with a dash and specifies an inclusive range of tests +to run. You may omit the first or the second number to mean "from the first test" or "up to the very last test" respectively. The argument to --run is split on commas into separate strings, @@ -274,10 +274,10 @@ text that you want to match includes a comma, use the glob character on all tests that match either the glob *rebase* or the glob *merge?cherry-pick*. -If --run starts with an unprefixed number or range the initial -set of tests to run is empty. If the first item starts with '!' +If --run starts with an unprefixed number or range, the initial +set of tests to run is empty. If the first item starts with '!', all the tests are added to the initial set. After initial set is -determined every test number or range is added or excluded from +determined, every test number or range is added or excluded from the set one by one, from left to right. For example, to run only tests up to a specific test (21), one @@ -579,11 +579,11 @@ This test harness library does the following things: Recommended style ----------------- -Here are some recommented styles when writing test case. - - Keep test title the same line with test helper function itself. + - Keep the test_expect_* function call and test title on + the same line. - Take test_expect_success helper for example, write it like: + For example, with test_expect_success, write it like: test_expect_success 'test title' ' ... test body ... @@ -595,10 +595,9 @@ Here are some recommented styles when writing test case. 'test title' \ '... test body ...' + - End the line with an opening single quote. - - End the line with a single quote. - - - Indent the body of here-document, and use "<<-" instead of "<<" + - Indent here-document bodies, and use "<<-" instead of "<<" to strip leading TABs used for indentation: test_expect_success 'test something' ' @@ -624,7 +623,7 @@ Here are some recommented styles when writing test case. ' - Quote or escape the EOF delimiter that begins a here-document if - there is no parameter and other expansion in it, to signal readers + there is no parameter or other expansion in it, to signal readers that they can skim it more casually: cmd <<-\EOF @@ -638,7 +637,7 @@ Do's & don'ts Here are a few examples of things you probably should and shouldn't do when writing tests. -Here are the "do's:" +The "do's:" - Put all code inside test_expect_success and other assertions. @@ -1237,8 +1236,8 @@ and it knows that the object ID of an empty tree is a certain because the things the very basic core test tries to achieve is to serve as a basis for people who are changing the Git internals drastically. For these people, after making certain changes, -not seeing failures from the basic test _is_ a failure. And -such drastic changes to the core Git that even changes these +not seeing failures from the basic test _is_ a failure. Any +Git core changes so drastic that they change even these otherwise supposedly stable object IDs should be accompanied by an update to t0000-basic.sh. @@ -1248,7 +1247,7 @@ knowledge of the core Git internals. If all the test scripts hardcoded the object IDs like t0000-basic.sh does, that defeats the purpose of t0000-basic.sh, which is to isolate that level of validation in one place. Your test also ends up needing -updating when such a change to the internal happens, so do _not_ +an update whenever the internals change, so do _not_ do it and leave the low level of validation to t0000-basic.sh. Test coverage From patchwork Thu Oct 5 09:00:52 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= X-Patchwork-Id: 13410143 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 08A6AE92706 for ; Thu, 5 Oct 2023 14:38:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229959AbjJEOiM (ORCPT ); Thu, 5 Oct 2023 10:38:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48736 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234186AbjJEOfU (ORCPT ); Thu, 5 Oct 2023 10:35:20 -0400 Received: from mail.smrk.net (mail.smrk.net [IPv6:2001:19f0:6c01:2788:5400:4ff:fe27:adaa]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 324F79ECA for ; Thu, 5 Oct 2023 02:02:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1696496531; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Gd9K0fOXysS/d+/E+0LZm/bHCFNctO6TorMWObD1REw=; b=JuXqgIWI2CsvDHr/Naf+pR4qLTkapkYZ7UCurNhYGFAhUYYyY+Z/Dl2recpNbbXz73AJTe JL/ITVTkgmIpF7Hs8+cnW6gDEIjQUIDJQbB7JV50eO1AVkWjsCUftuF66FicvVRnSiu11I JEY/qdM0tcUT8L+Gl9ZXWCENmhkMGbdw1QpdMph4B9aZ2HjfLtRP4Q0jDZQ0qng+VtR172 R96ccj3D/zqmPJdIUHX1EhDK37vTOIDJGGLDocKv5aUDoL1p2cCaOVfBeGr1I6Jj9o4sKu 1jYr1HDvHWvxQqrrGXROgmVVHLA/GoCp41i2861QzO2iHohcn4GY4wFS+fDpuA== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id 8d14beb3 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Thu, 5 Oct 2023 11:02:11 +0200 (CEST) From: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= To: git@vger.kernel.org Subject: [PATCH v2 2/5] doc/diff-options: improve wording of the log.diffMerges mention Date: Thu, 5 Oct 2023 11:00:52 +0200 Message-ID: <20231005090055.3097783-2-stepnem@smrk.net> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231005090055.3097783-1-stepnem@smrk.net> References: <20231003082107.3002173-1-stepnem@smrk.net> <20231005090055.3097783-1-stepnem@smrk.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Fix the grammar ("which default value is") and reword to match other similar descriptions (say "configuration variable" instead of "parameter", link to git-config(1)). Signed-off-by: Štěpán Němec --- Documentation/diff-options.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index ee256ec077be..48a5012748dd 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -53,9 +53,9 @@ ifdef::git-log[] -m::: This option makes diff output for merge commits to be shown in the default format. `-m` will produce the output only if `-p` - is given as well. The default format could be changed using - `log.diffMerges` configuration parameter, which default value - is `separate`. + is given as well. The default format can be specified using + the configuration variable `log.diffMerges` (see + linkgit:git-config[1]). It defaults to `separate`. + --diff-merges=first-parent::: --diff-merges=1::: From patchwork Thu Oct 5 09:00:53 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= X-Patchwork-Id: 13410096 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B3A14E92701 for ; Thu, 5 Oct 2023 14:09:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231162AbjJEOJF (ORCPT ); Thu, 5 Oct 2023 10:09:05 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53292 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229817AbjJEOHB (ORCPT ); Thu, 5 Oct 2023 10:07:01 -0400 Received: from mail.smrk.net (mail.smrk.net [IPv6:2001:19f0:6c01:2788:5400:4ff:fe27:adaa]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 940719ECB for ; Thu, 5 Oct 2023 02:02:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1696496532; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=nyJn+JFuAmnNdt8nzCFIwLmvxSkUqXcw/M6fV+/TJkM=; b=WxIzlQjdiD8scjwmOQZc+xOLShwehualcCh/54hGcGDCW+MzQqwykek7+NJly+5sll3bng 5z8tZk0OpPM8Cis7ajKHWp5xMQATXvFY35Lles1cEXuBd0Fr+kvH46R5NwEmTcAT/9l+c9 hpJ9d2FdnxdtLuQFxCNEy3D1TR5/HkIL2GkZGg5EGDAQGQLVoP4WI5Qng1dTOpu9JxTEj9 AMCeUTwBrihD8HYumi+PuIAAyA2F2WwDE89kFm9CXEwKJ58u5aRlSyyq4j/vcfW8djZYMK s2QJGVUXUU58nhQyQrDdtXa4hoLP7h22PaG/5WnD/1HJKppd4I3zpXU74emPtA== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id bd7d1c07 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Thu, 5 Oct 2023 11:02:12 +0200 (CEST) From: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= To: git@vger.kernel.org Subject: [PATCH v2 3/5] git-jump: admit to passing merge mode args to ls-files Date: Thu, 5 Oct 2023 11:00:53 +0200 Message-ID: <20231005090055.3097783-3-stepnem@smrk.net> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231005090055.3097783-1-stepnem@smrk.net> References: <20231003082107.3002173-1-stepnem@smrk.net> <20231005090055.3097783-1-stepnem@smrk.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org There's even an example of such usage in the README. Fixes: 67ba13e5a4b2 ("git-jump: pass "merge" arguments to ls-files") Signed-off-by: Štěpán Němec --- contrib/git-jump/git-jump | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/git-jump/git-jump b/contrib/git-jump/git-jump index 40c4b0d11107..47e0c557e63f 100755 --- a/contrib/git-jump/git-jump +++ b/contrib/git-jump/git-jump @@ -9,7 +9,7 @@ The parameter is one of: diff: elements are diff hunks. Arguments are given to diff. -merge: elements are merge conflicts. Arguments are ignored. +merge: elements are merge conflicts. Arguments are given to ls-files -u. grep: elements are grep hits. Arguments are given to git grep or, if configured, to the command in `jump.grepCmd`. From patchwork Thu Oct 5 09:00:54 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= X-Patchwork-Id: 13410297 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id F2AF0E772B8 for ; Thu, 5 Oct 2023 16:06:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237719AbjJEQFb (ORCPT ); Thu, 5 Oct 2023 12:05:31 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53494 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237633AbjJEQEJ (ORCPT ); Thu, 5 Oct 2023 12:04:09 -0400 Received: from mail.smrk.net (mail.smrk.net [IPv6:2001:19f0:6c01:2788:5400:4ff:fe27:adaa]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 25B2E9ECC for ; Thu, 5 Oct 2023 02:02:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1696496533; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=5ao9Tj9QTDP3VIKdxI8BbdCv5My85FP/70CqR7uxe9k=; b=eM7R1qmI+qkzuJ1LcPu68+iyifHRdkdQDEdtY5f8zOlsQmk3Xk7EjOE/XSMk19/B2a/+AT j7DN3TsLY2wtXNac93ANblb02Mle3dYDg4Wor8EXJEb0iBxRLWlp1DNNNmCKBkx6fsx5lx r4JwXP/ob2yl+gU+Liilf3jcyxs+w2m8APcCQA9gFh3jQYMBMS3fBkHbGqR3+smxwb94KF mTi70GAFKBtt1VPtAb7qOscNr2/Qv+CoUQG8QsDS8yy18sMU+X8JcktktPkRWNxx4Efy4D g7h/RZnH2j0qW4lgqSm93KnWlXylyCHVaayhDb6VgYUYqzpxgKgzV1XrBh1CIg== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id 4408572f (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Thu, 5 Oct 2023 11:02:13 +0200 (CEST) From: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= To: git@vger.kernel.org Subject: [PATCH v2 4/5] doc/gitk: s/sticked/stuck/ Date: Thu, 5 Oct 2023 11:00:54 +0200 Message-ID: <20231005090055.3097783-4-stepnem@smrk.net> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231005090055.3097783-1-stepnem@smrk.net> References: <20231003082107.3002173-1-stepnem@smrk.net> <20231005090055.3097783-1-stepnem@smrk.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The terminology was changed in b0d12fc9b23a (Use the word 'stuck' instead of 'sticked'). Signed-off-by: Štěpán Němec --- Documentation/gitk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index d50e9ed10e04..c2213bb77b38 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -26,7 +26,7 @@ changes each commit introduces are shown. Finally, it supports some gitk-specific options. gitk generally only understands options with arguments in the -'sticked' form (see linkgit:gitcli[7]) due to limitations in the +'stuck' form (see linkgit:gitcli[7]) due to limitations in the command-line parser. rev-list options and arguments From patchwork Thu Oct 5 09:00:55 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= X-Patchwork-Id: 13410094 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 81AEFE92703 for ; Thu, 5 Oct 2023 14:05:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229887AbjJEOFU (ORCPT ); Thu, 5 Oct 2023 10:05:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52640 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229900AbjJEODq (ORCPT ); Thu, 5 Oct 2023 10:03:46 -0400 Received: from mail.smrk.net (mail.smrk.net [IPv6:2001:19f0:6c01:2788:5400:4ff:fe27:adaa]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8DC6D9ECD for ; Thu, 5 Oct 2023 02:02:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=smrk.net; s=20221002; t=1696496534; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=bTzAQMiRk5+qjbfhvpDLfexLntzTNz6ecxAthnzMxHU=; b=ijYD0SalTWrRhpFoBkCznK03ZLuvZbtd0SoO6QAXzMoMhhccaC/AO7/l05fx3pCp+hoWWH QCeYg3ItYMVVNQSqtU0y7wk8aS3L4dvSMN7Kop5WDcdTPkcaiqb1szG/M4rOXeaZ4aC22L ZWsWrTP8aNs2J7OvCkphRUo+OdRp5hkdC0AQkIsP5S4tEvxImiWE+Cp84fQNPVxYY8eTln 9I0DYG0KfFkDxGyEUUf8Htagj22Zwk3mwJHc8rdvvo1TKg7sMFiDz1AuA6dKvPm5JKFJgh ApBIOXb7BzlGIHF2X1W8/lZgn2/ExKUQtULb8tYNE3hnxYZTX0gmS7Z7nGIKKQ== Received: from localhost ( [192.168.5.2]) by smrk (OpenSMTPD) with ESMTPSA id 425a4770 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Thu, 5 Oct 2023 11:02:14 +0200 (CEST) From: =?utf-8?b?xaB0xJtww6FuIE7Em21lYw==?= To: git@vger.kernel.org Subject: [PATCH v2 5/5] t/README: fix multi-prerequisite example Date: Thu, 5 Oct 2023 11:00:55 +0200 Message-ID: <20231005090055.3097783-5-stepnem@smrk.net> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231005090055.3097783-1-stepnem@smrk.net> References: <20231003082107.3002173-1-stepnem@smrk.net> <20231005090055.3097783-1-stepnem@smrk.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org With the broken quoting the test wouldn't even parse correctly, but there's also the '==' instead of POSIX '=' (of the shells I tested, busybox ash, bash and ksh (93 and OpenBSD) accept '==', dash and zsh do not), and 'print 2' from Python 2 days. (I assume the test failing due to 3 != 4 is intentional or immaterial.) Fixes: 93a572461386 ("test-lib: Add support for multiple test prerequisites") Signed-off-by: Štěpán Němec --- t/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/t/README b/t/README index 2ef89785f831..a0ebe294848d 100644 --- a/t/README +++ b/t/README @@ -887,7 +887,7 @@ see test-lib-functions.sh for the full list and their options. rare case where your test depends on more than one: test_expect_success PERL,PYTHON 'yo dawg' \ - ' test $(perl -E 'print eval "1 +" . qx[python -c "print 2"]') == "4" ' + ' test $(perl -E '\''print eval "1 +" . qx[python -c "print(2)"]'\'') = "4" ' - test_expect_failure []