From patchwork Thu Jul 14 17:44:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matheus Tavares X-Patchwork-Id: 12918298 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 CD52CC433EF for ; Thu, 14 Jul 2022 17:44:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240322AbiGNRoV (ORCPT ); Thu, 14 Jul 2022 13:44:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38940 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240326AbiGNRoS (ORCPT ); Thu, 14 Jul 2022 13:44:18 -0400 Received: from mail-oa1-x33.google.com (mail-oa1-x33.google.com [IPv6:2001:4860:4864:20::33]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B7B751705B for ; Thu, 14 Jul 2022 10:44:17 -0700 (PDT) Received: by mail-oa1-x33.google.com with SMTP id 586e51a60fabf-10cf9f5b500so2191150fac.2 for ; Thu, 14 Jul 2022 10:44:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=usp.br; s=usp-google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=dc90NpyMe8caA3WBGkIphVhIhtz8+JLCQgomoV5s7iI=; b=eqm0iA80zurSwx3MwxdVJHNTTVg70ktcXkKpEDHsaeEVELpnFAl2o3gruw32TXlXj3 T8aUQjB7XH1GtgeDGHqIzxc0ZPdvcarYvc3vvHoPZxXLcRmcuMVTAP/uAzlKyeGeKy4G aLb/OZh0ibhmXx32Ba5pObgJkgjCCcfsKDhBmtN2HQY6a8pwoxoet45gtFHPTXLJgSiM CP0ZC1QGci+I6wBD8lWHpEf16iR732wHfh/gnC3fP/w7dGTxn+TiVDv2p3DOI/uRhTLU csXpzMYFS5o1ey1gRQdWlXFEUxECG+huMJiR2/8lLTPTwUALyKxIFysIigwgkOX2l4JZ gsrA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=dc90NpyMe8caA3WBGkIphVhIhtz8+JLCQgomoV5s7iI=; b=BucZCejZ2q34chaBxVegsUtVvd6uiX9MYad3wZtnklf8ebTFi8WHaGyNBdw0Dambwq stzy92RyZwV7vByoIz9LssGkoLFJbYv6MTjJBcIPXyLcHg46aBVLQBO6OvnIpaQTUD6D HtUOtIyRNqjXXvMAw6EiHAe5WjDV7cevw42rTTJXsF9szVS46Lqge7PfsZpXbVkWijmx ieOxwAOTx817VfzIN2yb1E8wS0uyneKguIOVjt48ZfL1o8mq1kZsjHGfWxn6LOiVfrYn aynHE/OnOyA2pe5uW09R5Q7DpnXgPIb3N5AVblM/Hox5cfUAXWBtd7Uzn6MSm8wUGQKd E7RQ== X-Gm-Message-State: AJIora+VCzrnfr4NPDoWAhkpq9Noz61GSALPXNtjwL2J4UgceILoLrQD 0Ss6JwTzhEDg5+iFzU3CMt7kCSZLA8VJeg== X-Google-Smtp-Source: AGRyM1tLSSzaXlzVqAejiM5GcSjE7RYLQ1f01dnCoNKO5Lf5EQnUCvK39UkcBlfT9Z+l5d+MTpeyFA== X-Received: by 2002:a05:6871:28c:b0:10b:fbbc:5fee with SMTP id i12-20020a056871028c00b0010bfbbc5feemr7829459oae.127.1657820656667; Thu, 14 Jul 2022 10:44:16 -0700 (PDT) Received: from mango.meuintelbras.local ([177.32.109.17]) by smtp.gmail.com with ESMTPSA id bx17-20020a056830601100b0061c5ea08b2bsm906304otb.77.2022.07.14.10.44.15 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Jul 2022 10:44:16 -0700 (PDT) From: Matheus Tavares To: git@vger.kernel.org Subject: [PATCH 1/3] doc: grep: unify configuration variables definitions Date: Thu, 14 Jul 2022 14:44:02 -0300 Message-Id: <439cfdf858f5b1917ae7ca3ca327bb33b42f71c7.1657819649.git.matheus.bernardino@usp.br> X-Mailer: git-send-email 2.37.0 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The configuration variables for git-grep are duplicated in "Documentation/git-grep.txt" and "Documentation/config/grep.txt", which gqcan make maintenance difficult. The first also contains a definition that is not present in the latter (grep.fullName), and the latter received a wording improvement that was not replicated in the former: see 91028f765 ("grep: clarify what `grep.patternType=default` means", 2021-12-05). To avoid such problems, unify the information in one file and include it in the other. Signed-off-by: Matheus Tavares --- Documentation/config/grep.txt | 10 ++++++++-- Documentation/git-grep.txt | 37 ++++++----------------------------- 2 files changed, 14 insertions(+), 33 deletions(-) diff --git a/Documentation/config/grep.txt b/Documentation/config/grep.txt index 182edd813a..6996e64574 100644 --- a/Documentation/config/grep.txt +++ b/Documentation/config/grep.txt @@ -17,8 +17,14 @@ grep.extendedRegexp:: other than 'default'. grep.threads:: - Number of grep worker threads to use. - See `grep.threads` in linkgit:git-grep[1] for more information. + Number of grep worker threads to use. See `--threads` +ifndef::git-grep[] + in linkgit:git-grep[1] +endif::git-grep[] + for more information. + +grep.fullName:: + If set to true, enable `--full-name` option by default. grep.fallbackToNoIndex:: If set to true, fall back to git grep --no-index if git grep diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 3d393fbac1..65a3ca1101 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -37,7 +37,6 @@ registered in the index file, or blobs in given tree objects. Patterns are lists of one or more search expressions separated by newline characters. An empty string as search expression matches all lines. - OPTIONS ------- --cached:: @@ -239,8 +238,10 @@ providing this option will cause it to die. custom hunk-header' in linkgit:gitattributes[5]). --threads :: - Number of grep worker threads to use. - See `grep.threads` in 'CONFIGURATION' for more information. + Number of grep worker threads to use. If not provided (or set to + 0), Git will use as many worker threads as the number of logical + cores available. The default value can also be set with the + `grep.threads` configuration. -f :: Read patterns from , one per line. @@ -334,34 +335,8 @@ performance in this case, it might be desirable to use `--threads=1`. CONFIGURATION ------------- -grep.lineNumber:: - If set to true, enable `-n` option by default. - -grep.column:: - If set to true, enable the `--column` option by default. - -grep.patternType:: - Set the default matching behavior. Using a value of 'basic', 'extended', - 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`, - `--fixed-strings`, or `--perl-regexp` option accordingly, while the - value 'default' will return to the default matching behavior. - -grep.extendedRegexp:: - If set to true, enable `--extended-regexp` option by default. This - option is ignored when the `grep.patternType` option is set to a value - other than 'default'. - -grep.threads:: - Number of grep worker threads to use. If unset (or set to 0), Git will - use as many threads as the number of logical cores available. - -grep.fullName:: - If set to true, enable `--full-name` option by default. - -grep.fallbackToNoIndex:: - If set to true, fall back to git grep --no-index if git grep - is executed outside of a git repository. Defaults to false. - +:git-grep: 1 +include::config/grep.txt[] GIT --- From patchwork Thu Jul 14 17:44:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matheus Tavares X-Patchwork-Id: 12918299 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 77F15C43334 for ; Thu, 14 Jul 2022 17:44:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240384AbiGNRoW (ORCPT ); Thu, 14 Jul 2022 13:44:22 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38964 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240374AbiGNRoU (ORCPT ); Thu, 14 Jul 2022 13:44:20 -0400 Received: from mail-oa1-x2a.google.com (mail-oa1-x2a.google.com [IPv6:2001:4860:4864:20::2a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BA8E517593 for ; Thu, 14 Jul 2022 10:44:19 -0700 (PDT) Received: by mail-oa1-x2a.google.com with SMTP id 586e51a60fabf-10bec750eedso3302638fac.8 for ; Thu, 14 Jul 2022 10:44:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=usp.br; s=usp-google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=Egf4uiUaAGMsKUgyMm7wLfO8MohWRPTTE0BbshagsR4=; b=rCVKr+dQGOacyPQFgc/YQPhSRa8E/kznFTvxzJDOzhX6jM7RdDReK92+K2SXaMeQpD 7W1ug/Q4/UOO8fwMGHgf7oFSFo4LJEPUw/2itOgJAwMjFLfZQ/3q3JGI/RCLid6SHdwK 04bcvCbbyoiMUhqE+LpafZrQT83tfpX0paGENBdg0cyvd5xhVV2TqoekpmApE5wuZhfW 1u4cEm8lEA2iedAF4PzeCLRmZ9bVGBpM2avaQQyWWs9HdF0uAVeMF0sMrE3H8yCT0Wy7 SwPWO7j8Ovt3mrYWoCMA5BHRSXKSV5TAKhBh44RkFKcfYBVHlrW1ZzO/GUOMGiZsLBy1 zvOQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Egf4uiUaAGMsKUgyMm7wLfO8MohWRPTTE0BbshagsR4=; b=LpzSq99sbd0lZf2hv/eGlAZPVuoeoKAdemWJytArDIEcasBDgpDaNtUkxZNrdeOCBp HLCQboymJXNU70dlFpvfX8gp2eejt06AZqW0BMjQDp11lknBFENBExgw9QNmjcNjzGer m81J3e0zPTOvxgPGRStJZfkPOHJ/Q3LK1fwE/flnknyGih5/GACCS6tGr+CarzrOXkpP ePShc7/cJtqg9n22Lw0l5CCPAQBjalkm813/XUxAppIkKbWJSQwtIL53VDkkrkqp7mz2 uEeIJlMrWbg72jokWZ3N3w5fY1WcQuiHbjvfyN9UGWv3LqtUe0Q33rGqwIfambfFo0pE KMjw== X-Gm-Message-State: AJIora/7qaC4bMCFS4EgxDR2vlkW6aM1NLUWCFVV/0zHOKBEAqKgfWir of0ZzN7u0X7O83GYwqt3pUC1oRUxUT65AA== X-Google-Smtp-Source: AGRyM1vScl6Ir5zs70eWC8fG1yERbfhRbMCxfNGso9IPHg39omklYnWBTBNrw/pvR9zrUl1uNHfqgQ== X-Received: by 2002:a05:6870:461b:b0:e9:a015:36a6 with SMTP id z27-20020a056870461b00b000e9a01536a6mr7594968oao.185.1657820658702; Thu, 14 Jul 2022 10:44:18 -0700 (PDT) Received: from mango.meuintelbras.local ([177.32.109.17]) by smtp.gmail.com with ESMTPSA id bx17-20020a056830601100b0061c5ea08b2bsm906304otb.77.2022.07.14.10.44.17 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Jul 2022 10:44:18 -0700 (PDT) From: Matheus Tavares To: git@vger.kernel.org Subject: [PATCH 2/3] doc: apply: unify configuration variables definitions Date: Thu, 14 Jul 2022 14:44:03 -0300 Message-Id: X-Mailer: git-send-email 2.37.0 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Note that apply.ignoreWhitespace and apply.whitespace are defined with slightly different wordings at git-apply.txt and config/apply.txt. Nevertheless, there is no loss of information from using one or the other, so I kept the latter for the single unified definition. Signed-off-by: Matheus Tavares --- Documentation/config/apply.txt | 7 ++++++- Documentation/git-apply.txt | 9 ++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/config/apply.txt b/Documentation/config/apply.txt index 8fb8ef763d..7fb1ae7f8a 100644 --- a/Documentation/config/apply.txt +++ b/Documentation/config/apply.txt @@ -4,8 +4,13 @@ apply.ignoreWhitespace:: option. When set to one of: no, none, never, false tells 'git apply' to respect all whitespace differences. +ifndef::git-apply[] See linkgit:git-apply[1]. +endif::git-apply[] apply.whitespace:: Tells 'git apply' how to handle whitespaces, in the same way - as the `--whitespace` option. See linkgit:git-apply[1]. + as the `--whitespace` option. +ifndef::git-apply[] + See linkgit:git-apply[1]. +endif::git-apply[] diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index b6d77f4206..7ababdaaa7 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -263,13 +263,8 @@ has no effect when `--index` or `--cached` is in use. CONFIGURATION ------------- -apply.ignoreWhitespace:: - Set to 'change' if you want changes in whitespace to be ignored by default. - Set to one of: no, none, never, false if you want changes in - whitespace to be significant. -apply.whitespace:: - When no `--whitespace` flag is given from the command - line, this configuration item is used as the default. +:git-apply: 1 +include::config/apply.txt[] SUBMODULES ---------- From patchwork Thu Jul 14 17:44:04 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matheus Tavares X-Patchwork-Id: 12918300 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 AD9CBC433EF for ; Thu, 14 Jul 2022 17:44:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240475AbiGNRob (ORCPT ); Thu, 14 Jul 2022 13:44:31 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39132 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240403AbiGNRo0 (ORCPT ); Thu, 14 Jul 2022 13:44:26 -0400 Received: from mail-oi1-x235.google.com (mail-oi1-x235.google.com [IPv6:2607:f8b0:4864:20::235]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D073E186E7 for ; Thu, 14 Jul 2022 10:44:21 -0700 (PDT) Received: by mail-oi1-x235.google.com with SMTP id u9so3212932oiv.12 for ; Thu, 14 Jul 2022 10:44:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=usp.br; s=usp-google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=u9kkIWUTw8DSDAEJ14lLdrgdrZaTmyQ7acSDoNs44Gk=; b=Mp6TfQhgOLr6FCDOj+5SSWg84NFhOECVucroLlw3WsKhFnhaO6gmX4r/pm1pjmMua0 /H0tIDWGKbmDE5PGt2bDBYmlKWrHAB39iriERxSX+0Cb+T3K0ZXfrhBiYk1HEshE46M5 tLZ9krpVt5oWXiALz053otzdn7ElOxrSCN2//XTCTTp6YLc4v4CUbxzClLHB8jvNKc7x jncKD6ccRWvWEAaxc6cYxdEpECiImHcJ+HS85dEpQZmOllB9lbspl473gqdrW6r/C3TK TOBjuOugnPDtw/OM+HltfT0ciwE5hdjK44rI2OtsJMlYDCej0akxjqhn/VhjDNXaefVM wTbg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=u9kkIWUTw8DSDAEJ14lLdrgdrZaTmyQ7acSDoNs44Gk=; b=WPZVBPTsboFximfCh7r/d+b+EGT7Ygt9HTwe4beXNzbe3BiaFuh3Azmy+tSkbOvLWm Di0+yxlGwkApKAdCp3I1klTLXEZkcH/8iiOhX5LtZQnjUgs2/sD/iKcLNx6hlrSpWE8X 9kTI9Qbg0gEBV3Z18n19KyAH5S/+hn8QPivX5PjTIK8LtJklQxZT+OFM+eTqHG8X/s9J Hq9YRu1j1mpwW+8Frm0zUbauF/Nvjn90+lIhQ3y5z1pZaubf7rk388enegdzD4UQIXgc FXDl8LyeqfgzanrIob6O66sTW5eL9X9Q2Bo9mrxqB7Y7G+EJHMn2P0b+SCt8OEvowQ5D 8Zkw== X-Gm-Message-State: AJIora/iIBLXh/FyQBDlRxhNGAjiIm1mGrotVuhuke7bXbRykZifX1Cm dM3W6Ud22i9iEnDNwiK5bZO10patI34TlQ== X-Google-Smtp-Source: AGRyM1u0Gsm9myoGQo3xlYOwpFpH1NnzbnpMy/f/cImvzeQh3Rgcdhc+MsXAhzJ5Nt+c/F7FN4gfkA== X-Received: by 2002:a05:6808:1a26:b0:33a:11da:196 with SMTP id bk38-20020a0568081a2600b0033a11da0196mr7547797oib.185.1657820660702; Thu, 14 Jul 2022 10:44:20 -0700 (PDT) Received: from mango.meuintelbras.local ([177.32.109.17]) by smtp.gmail.com with ESMTPSA id bx17-20020a056830601100b0061c5ea08b2bsm906304otb.77.2022.07.14.10.44.19 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 14 Jul 2022 10:44:20 -0700 (PDT) From: Matheus Tavares To: git@vger.kernel.org Subject: [PATCH 3/3] doc: notes: unify configuration variables definitions Date: Thu, 14 Jul 2022 14:44:04 -0300 Message-Id: X-Mailer: git-send-email 2.37.0 In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Unify duplicated configuration descriptions from git-notes.txt and config.txt in order to facilitate maintenance and update. There are some discrepancies between these two files: git-notes.txt received two updates that were not made in config.txt: see 66c4c32 ("Documentation/notes: simplify treatment of default display refs", 2010-05-08) and c5ce183 ("Documentation/notes: clean up description of rewriting configuration", 2010-05-08 ). And there was also an update to config.txt not propagated to git-notes.txt: see 2b4aa89 ("Documentation: basic configuration of notes.rewriteRef", 2011-09-13). Let's make sure to include all these three updates in the unified version. Signed-off-by: Matheus Tavares --- Documentation/config/notes.txt | 62 ++++++++++++++++------------------ Documentation/git-notes.txt | 54 ++--------------------------- 2 files changed, 31 insertions(+), 85 deletions(-) diff --git a/Documentation/config/notes.txt b/Documentation/config/notes.txt index aeef56d49a..552b340987 100644 --- a/Documentation/config/notes.txt +++ b/Documentation/config/notes.txt @@ -2,58 +2,54 @@ notes.mergeStrategy:: Which merge strategy to choose by default when resolving notes conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" - section of linkgit:git-notes[1] for more information on each strategy. + section +ifdef::git-notes[above] +ifndef::git-notes[of linkgit:git-notes[1]] + for more information on each strategy. notes..mergeStrategy:: Which merge strategy to choose when doing a notes merge into refs/notes/. This overrides the more general - "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in - linkgit:git-notes[1] for more information on the available strategies. + "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section +ifdef::git-notes[above] +ifndef::git-notes[in linkgit:git-notes[1]] + for more information on the available strategies. notes.displayRef:: - The (fully qualified) refname from which to show notes when - showing commit messages. The value of this variable can be set - to a glob, in which case notes from all matching refs will be - shown. You may also specify this configuration variable - several times. A warning will be issued for refs that do not - exist, but a glob that does not match any refs is silently - ignored. -+ -This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` -environment variable, which must be a colon separated list of refs or -globs. -+ -The effective value of "core.notesRef" (possibly overridden by -GIT_NOTES_REF) is also implicitly added to the list of refs to be -displayed. + Which ref (or refs, if a glob or specified more than once), in + addition to the default set by `core.notesRef` or + `GIT_NOTES_REF`, to read notes from when showing commit + messages with the 'git log' family of commands. + This setting can be overridden on the command line or by the + `GIT_NOTES_DISPLAY_REF` environment variable. + See linkgit:git-log[1]. notes.rewrite.:: When rewriting commits with (currently `amend` or - `rebase`) and this variable is set to `true`, Git - automatically copies your notes from the original to the - rewritten commit. Defaults to `true`, but see - "notes.rewriteRef" below. + `rebase`), if this variable is `false`, git will not copy + notes from the original to the rewritten commit. Defaults to + `true`. See also "`notes.rewriteRef`" below. ++ +This setting can be overridden by the `GIT_NOTES_REWRITE_REF` +environment variable. notes.rewriteMode:: - When copying notes during a rewrite (see the - "notes.rewrite." option), determines what to do if - the target commit already has a note. Must be one of - `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`. - Defaults to `concatenate`. + When copying notes during a rewrite, what to do if the target + commit already has a note. Must be one of `overwrite`, + `concatenate`, `cat_sort_uniq`, or `ignore`. Defaults to + `concatenate`. + This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` environment variable. notes.rewriteRef:: When copying notes during a rewrite, specifies the (fully - qualified) ref whose notes should be copied. The ref may be a - glob, in which case notes in all matching refs will be copied. - You may also specify this configuration several times. + qualified) ref whose notes should be copied. May be a glob, + in which case notes in all matching refs will be copied. You + may also specify this configuration several times. + Does not have a default value; you must configure this variable to enable note rewriting. Set it to `refs/notes/commits` to enable rewriting for the default commit notes. + -This setting can be overridden with the `GIT_NOTES_REWRITE_REF` -environment variable, which must be a colon separated list of refs or -globs. +Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable. diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 0a4200674c..79b2c60646 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -316,58 +316,8 @@ core.notesRef:: This setting can be overridden through the environment and command line. -notes.mergeStrategy:: - Which merge strategy to choose by default when resolving notes - conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or - `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" - section above for more information on each strategy. -+ -This setting can be overridden by passing the `--strategy` option. - -notes..mergeStrategy:: - Which merge strategy to choose when doing a notes merge into - refs/notes/. This overrides the more general - "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section above - for more information on each available strategy. - -notes.displayRef:: - Which ref (or refs, if a glob or specified more than once), in - addition to the default set by `core.notesRef` or - `GIT_NOTES_REF`, to read notes from when showing commit - messages with the 'git log' family of commands. - This setting can be overridden on the command line or by the - `GIT_NOTES_DISPLAY_REF` environment variable. - See linkgit:git-log[1]. - -notes.rewrite.:: - When rewriting commits with (currently `amend` or - `rebase`), if this variable is `false`, git will not copy - notes from the original to the rewritten commit. Defaults to - `true`. See also "`notes.rewriteRef`" below. -+ -This setting can be overridden by the `GIT_NOTES_REWRITE_REF` -environment variable. - -notes.rewriteMode:: - When copying notes during a rewrite, what to do if the target - commit already has a note. Must be one of `overwrite`, - `concatenate`, `cat_sort_uniq`, or `ignore`. Defaults to - `concatenate`. -+ -This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` -environment variable. - -notes.rewriteRef:: - When copying notes during a rewrite, specifies the (fully - qualified) ref whose notes should be copied. May be a glob, - in which case notes in all matching refs will be copied. You - may also specify this configuration several times. -+ -Does not have a default value; you must configure this variable to -enable note rewriting. -+ -Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable. - +:git-notes: 1 +include::config/notes.txt[] ENVIRONMENT -----------