From patchwork Thu Oct 8 05:48:14 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Denton Liu X-Patchwork-Id: 11822193 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_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT 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 4356DC4363C for ; Thu, 8 Oct 2020 05:48:28 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F31222087D for ; Thu, 8 Oct 2020 05:48:27 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="magyrG7/" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728270AbgJHFs1 (ORCPT ); Thu, 8 Oct 2020 01:48:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60692 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726245AbgJHFs0 (ORCPT ); Thu, 8 Oct 2020 01:48:26 -0400 Received: from mail-pl1-x641.google.com (mail-pl1-x641.google.com [IPv6:2607:f8b0:4864:20::641]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 50CF4C061755 for ; Wed, 7 Oct 2020 22:48:26 -0700 (PDT) Received: by mail-pl1-x641.google.com with SMTP id s19so2225840plp.3 for ; Wed, 07 Oct 2020 22:48:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=rSDQFwwU9U0XPnizLMK7RwRZdstZGhgKUdKQUokSiLU=; b=magyrG7/4gkpkeHur7Hwz1fOAzH6iK+yLq3jnSFKX1g1lSk4c7f0f7gCbY0+1LBF20 pX+g5dTNSTckeMzF2mH2y2RiuzTmxx1JQIprHKl0EvAMwaGuWOYC8yYaD35IClL9c28H /jNAbMrs2VqZkWv3h1LTm/mCaRClkbF0qcxHGdbOZC6pWl7ymK1TsJfbiq1Qudby7vgz NjQBPk4fDJy3c6KxSX95GGFEVpxfFJ7tIqeGB1eiwRvn/77CInZ+QVZewXrvjEDVqOTk fQSNGQU543yLKPmNkzwcxtOyzvLLqJX2W7FQXrCjw1jDvbkYOhXap5IwtWwoWVz6kATT kP3w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=rSDQFwwU9U0XPnizLMK7RwRZdstZGhgKUdKQUokSiLU=; b=AoILRMKkc7E934nbH/g0OVgik6gMGpref21D5O3w7K0MdEpi+d7ZcnpEUSdLhCWJN9 taB2NQru8TZoCV0VgdB3a/pBNyD3RSh0LQOlSUX31Ed7zkKx1dERxw+m/mRduVfEts5+ nxtmlHfwv+sV08YjBDxLWc1mbTr1ycBSEHFEG/6Pi7ZKTG0OSJMd70ZqUftTc+d9I/2P FeA3tuvWP184rvuFnvDqYPrP+/Qb3q3ueLnmZUxOncQaYsvp/7+3ZPiiFRsPRFu4NKog dUdwBbilKh291AB3l+5VdzrU3WhwH49D3lHU5WY/Nl9XNuVxE60+NAdacWj0fAsg3Si6 SjlQ== X-Gm-Message-State: AOAM530w/c+SPpz4vkiE6bQUa7InQkj9nc5Ws3yJPufTyIduXtU73Fbc EDRdK3PThoz2tMMqBtzCqQDK0LzX+Qo= X-Google-Smtp-Source: ABdhPJx8oJry2vA7IBbid4ZlATTON3DdBm1OysqsEL07sd8Kw/sfYD34X2xDTrynXA0bmFdT+njh1g== X-Received: by 2002:a17:902:ac8c:b029:d3:7f4a:70db with SMTP id h12-20020a170902ac8cb02900d37f4a70dbmr6091741plr.71.1602136105648; Wed, 07 Oct 2020 22:48:25 -0700 (PDT) Received: from archbookpro.hsd1.ca.comcast.net (c-67-188-114-10.hsd1.ca.comcast.net. [67.188.114.10]) by smtp.gmail.com with ESMTPSA id g4sm5706169pgg.75.2020.10.07.22.48.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Oct 2020 22:48:25 -0700 (PDT) From: Denton Liu To: Git Mailing List Cc: Junio C Hamano Subject: [PATCH v3 1/2] Documentation/config/checkout: replace sq with backticks Date: Wed, 7 Oct 2020 22:48:14 -0700 Message-Id: X-Mailer: git-send-email 2.28.0.942.g77c4c6094c In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The modern style for Git documentation is to use backticks to quote any command-line documenation so that it is typeset in monospace. Replace all single quotes with backticks to conform to this. Signed-off-by: Denton Liu --- Documentation/config/checkout.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt index 6b646813ab..e3684a5459 100644 --- a/Documentation/config/checkout.txt +++ b/Documentation/config/checkout.txt @@ -1,18 +1,18 @@ checkout.defaultRemote:: - When you run 'git checkout ' - or 'git switch ' and only have one + When you run `git checkout ` + or `git switch ` and only have one remote, it may implicitly fall back on checking out and - tracking e.g. 'origin/'. This stops working as soon - as you have more than one remote with a '' + tracking e.g. `origin/`. This stops working as soon + as you have more than one remote with a `` reference. This setting allows for setting the name of a preferred remote that should always win when it comes to disambiguation. The typical use-case is to set this to `origin`. + Currently this is used by linkgit:git-switch[1] and -linkgit:git-checkout[1] when 'git checkout ' -or 'git switch ' -will checkout the '' branch on another remote, -and by linkgit:git-worktree[1] when 'git worktree add' refers to a +linkgit:git-checkout[1] when `git checkout ` +or `git switch ` +will checkout the `` branch on another remote, +and by linkgit:git-worktree[1] when `git worktree add` refers to a remote branch. This setting might be used for other checkout-like commands or functionality in the future. From patchwork Thu Oct 8 05:48:15 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Denton Liu X-Patchwork-Id: 11822195 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_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT 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 82CCDC47095 for ; Thu, 8 Oct 2020 05:48:29 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 323322087D for ; Thu, 8 Oct 2020 05:48:29 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="eufXgWJb" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728363AbgJHFs2 (ORCPT ); Thu, 8 Oct 2020 01:48:28 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60698 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726245AbgJHFs1 (ORCPT ); Thu, 8 Oct 2020 01:48:27 -0400 Received: from mail-pg1-x543.google.com (mail-pg1-x543.google.com [IPv6:2607:f8b0:4864:20::543]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 935A3C061755 for ; Wed, 7 Oct 2020 22:48:27 -0700 (PDT) Received: by mail-pg1-x543.google.com with SMTP id i2so3317408pgh.7 for ; Wed, 07 Oct 2020 22:48:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=tiq1XQj0gWilP3uZgcGxYI8VL2yGVNUOWMRbc9Kp1pE=; b=eufXgWJbd/9JPGS/fX0+8CymwTJISPjbCceIJ7XJcQ1fxGBWVNVJj/fTnQuLOAIMsP lmZbWkyxlxIJdJpXUR3hZMXEmVYUcqT+7CNjY/mHoGjCrwzAwvDGS160ndJMkEtG2HFJ lWKZBhft/p3B7RIagTO+f/6eV7kF0hJ00mZGWGEPfviiEC6opCK6+8Q7nrlsQf4yPX+4 +91tM5JALroBl+Act1hECGHX+xv6hUTauIrzh1yyYJ3eEdn9EHrSFvq7JvtCqujr30o+ Lltn/g150cvP4hbM/dJ7M6j4XwWQOOvtc/LAw3i3A7QeLMx7aw7+dFsZw0Gf+4gz1hXu 9nIA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=tiq1XQj0gWilP3uZgcGxYI8VL2yGVNUOWMRbc9Kp1pE=; b=Iq367a6Y3cD3/3m0+f1+ClgI7ljdfISeTNea03vwJC9y9vXK88NAGoRKSjP7IM/bmX Ahi6yQgXa23zNUmH6vq1UgPtILYCIVNLMqKleiTy4I+043aBEEi6f6aDZyaq167XwC+Z 03twYwx4cuzAo7gEfzBCR/MJqU5dxwl4XuyFWf0swLY2brV+RW+20TDQtaDf5m7thp5o 3VaI+vs1R6wpbvgCt3vwcNDDEI7sGmnI0/K9/IysX09pzhOJn8twC8FhFArOct+yGLES FVD6w/skz1Sz1EV244OGktP65kDk1pPOsCqdQNXDgl0a3q78uDiXGzlHThv9tp3Gujxe X0SQ== X-Gm-Message-State: AOAM531DXkgKDb3ykQUEFq9GKYVu3kRacWm1AQUt5VCR7RXp9o7UtXn0 q3a+ZWPG6C1B1EbuCgur+CpQvPTihO4= X-Google-Smtp-Source: ABdhPJzKwjjM9/+OZFftZjDW2vMZesy7fiSNDjGvqcv5pOnzn3T5i/eE7412eMwJ/yk9Eteta5yXcg== X-Received: by 2002:a17:90a:1548:: with SMTP id y8mr6316700pja.113.1602136106755; Wed, 07 Oct 2020 22:48:26 -0700 (PDT) Received: from archbookpro.hsd1.ca.comcast.net (c-67-188-114-10.hsd1.ca.comcast.net. [67.188.114.10]) by smtp.gmail.com with ESMTPSA id g4sm5706169pgg.75.2020.10.07.22.48.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 Oct 2020 22:48:26 -0700 (PDT) From: Denton Liu To: Git Mailing List Cc: Junio C Hamano Subject: [PATCH v3 2/2] checkout: learn to respect checkout.guess Date: Wed, 7 Oct 2020 22:48:15 -0700 Message-Id: X-Mailer: git-send-email 2.28.0.942.g77c4c6094c In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The current behavior of git checkout/switch is that --guess is currently enabled by default. However, some users may not wish for this to happen automatically. Instead of forcing users to specify --no-guess manually each time, teach these commands the checkout.guess configuration variable that gives users the option to set a default behavior. Teach the completion script to recognize the new config variable and disable DWIM logic if it is set to false. Signed-off-by: Denton Liu --- Documentation/config/checkout.txt | 5 +++ Documentation/git-checkout.txt | 5 ++- Documentation/git-switch.txt | 3 ++ builtin/checkout.c | 7 +++- contrib/completion/git-completion.bash | 25 ++++++++----- t/t2024-checkout-dwim.sh | 11 ++++++ t/t2060-switch.sh | 5 ++- t/t9902-completion.sh | 52 ++++++++++++++++++++++++++ 8 files changed, 101 insertions(+), 12 deletions(-) diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt index e3684a5459..2cddf7b4b4 100644 --- a/Documentation/config/checkout.txt +++ b/Documentation/config/checkout.txt @@ -16,3 +16,8 @@ will checkout the `` branch on another remote, and by linkgit:git-worktree[1] when `git worktree add` refers to a remote branch. This setting might be used for other checkout-like commands or functionality in the future. + +checkout.guess:: + Provides the default value for the `--guess` or `--no-guess` + option in `git checkout` and `git switch`. See + linkgit:git-switch[1] and linkgit:git-checkout[1]. diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index afa5c11fd3..1435d3de9e 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -192,7 +192,10 @@ branches from there if `` is ambiguous but exists on the 'origin' remote. See also `checkout.defaultRemote` in linkgit:git-config[1]. + -Use `--no-guess` to disable this. +`--guess` is the default behavior. Use `--no-guess` to disable it. ++ +The default behavior can be set via the `checkout.guess` configuration +variable. -l:: Create the new branch's reflog; see linkgit:git-branch[1] for diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt index 3759c3a265..5c438cd505 100644 --- a/Documentation/git-switch.txt +++ b/Documentation/git-switch.txt @@ -103,6 +103,9 @@ ambiguous but exists on the 'origin' remote. See also `checkout.defaultRemote` in linkgit:git-config[1]. + `--guess` is the default behavior. Use `--no-guess` to disable it. ++ +The default behavior can be set via the `checkout.guess` configuration +variable. -f:: --force:: diff --git a/builtin/checkout.c b/builtin/checkout.c index 0951f8fee5..0c0394a0d6 100644 --- a/builtin/checkout.c +++ b/builtin/checkout.c @@ -1093,11 +1093,16 @@ static int switch_branches(const struct checkout_opts *opts, static int git_checkout_config(const char *var, const char *value, void *cb) { + struct checkout_opts *opts = cb; + if (!strcmp(var, "diff.ignoresubmodules")) { - struct checkout_opts *opts = cb; handle_ignore_submodules_arg(&opts->diff_options, value); return 0; } + if (!strcmp(var, "checkout.guess")) { + opts->dwim_new_local_branch = git_config_bool(var, value); + return 0; + } if (starts_with(var, "submodule.")) return git_default_submodule_config(var, value, NULL); diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash index 8be4a0316e..851c358cfc 100644 --- a/contrib/completion/git-completion.bash +++ b/contrib/completion/git-completion.bash @@ -1467,14 +1467,15 @@ _git_bundle () # Helper function to decide whether or not we should enable DWIM logic for # git-switch and git-checkout. # -# To decide between the following rules in priority order -# 1) the last provided of "--guess" or "--no-guess" explicitly enable or -# disable completion of DWIM logic respectively. -# 2) If the --no-track option is provided, take this as a hint to disable the -# DWIM completion logic -# 3) If GIT_COMPLETION_CHECKOUT_NO_GUESS is set, disable the DWIM completion -# logic, as requested by the user. -# 4) Enable DWIM logic otherwise. +# To decide between the following rules in decreasing priority order: +# - the last provided of "--guess" or "--no-guess" explicitly enable or +# disable completion of DWIM logic respectively. +# - If checkout.guess is false, disable completion of DWIM logic. +# - If the --no-track option is provided, take this as a hint to disable the +# DWIM completion logic +# - If GIT_COMPLETION_CHECKOUT_NO_GUESS is set, disable the DWIM completion +# logic, as requested by the user. +# - Enable DWIM logic otherwise. # __git_checkout_default_dwim_mode () { @@ -1485,11 +1486,17 @@ __git_checkout_default_dwim_mode () fi # --no-track disables DWIM, but with lower priority than - # --guess/--no-guess + # --guess/--no-guess/checkout.guess if [ -n "$(__git_find_on_cmdline "--no-track")" ]; then dwim_opt="" fi + # checkout.guess = false disables DWIM, but with lower priority than + # --guess/--no-guess + if [ "$(__git config --type=bool checkout.guess)" = "false" ]; then + dwim_opt="" + fi + # Find the last provided --guess or --no-guess last_option="$(__git_find_last_on_cmdline "--guess --no-guess")" case "$last_option" in diff --git a/t/t2024-checkout-dwim.sh b/t/t2024-checkout-dwim.sh index accfa9aa4b..a4f8d3a67e 100755 --- a/t/t2024-checkout-dwim.sh +++ b/t/t2024-checkout-dwim.sh @@ -166,6 +166,17 @@ test_expect_success '--no-guess suppresses branch auto-vivification' ' test_branch master ' +test_expect_success 'checkout.guess = false suppresses branch auto-vivification' ' + git checkout -B master && + status_uno_is_clean && + test_might_fail git branch -D bar && + + test_config checkout.guess false && + test_must_fail git checkout bar && + test_must_fail git rev-parse --verify refs/heads/bar && + test_branch master +' + test_expect_success 'setup more remotes with unconventional refspecs' ' git checkout -B master && status_uno_is_clean && diff --git a/t/t2060-switch.sh b/t/t2060-switch.sh index 2c1b8c0d6d..68c9101b02 100755 --- a/t/t2060-switch.sh +++ b/t/t2060-switch.sh @@ -85,9 +85,12 @@ test_expect_success 'switching ignores file of same branch name' ' test_cmp expected actual ' -test_expect_success 'guess and create branch ' ' +test_expect_success 'guess and create branch' ' test_when_finished git switch master && test_must_fail git switch --no-guess foo && + test_config checkout.guess false && + test_must_fail git switch foo && + test_config checkout.guess true && git switch foo && echo refs/heads/foo >expected && git symbolic-ref HEAD >actual && diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh index 8425b9a531..2b469a71ca 100755 --- a/t/t9902-completion.sh +++ b/t/t9902-completion.sh @@ -1360,6 +1360,58 @@ test_expect_success 'git checkout - a later --no-guess overrides previous --gues EOF ' +test_expect_success 'git checkout - with checkout.guess = false, only completes refs' ' + test_config checkout.guess false && + test_completion "git checkout " <<-\EOF + HEAD Z + master Z + matching-branch Z + matching-tag Z + other/branch-in-other Z + other/master-in-other Z + EOF +' + +test_expect_success 'git checkout - with checkout.guess = true, completes refs and unique remote branches for DWIM' ' + test_config checkout.guess true && + test_completion "git checkout " <<-\EOF + HEAD Z + branch-in-other Z + master Z + master-in-other Z + matching-branch Z + matching-tag Z + other/branch-in-other Z + other/master-in-other Z + EOF +' + +test_expect_success 'git checkout - a later --guess overrides previous checkout.guess = false, complete refs and unique remote branches for DWIM' ' + test_config checkout.guess false && + test_completion "git checkout --guess " <<-\EOF + HEAD Z + branch-in-other Z + master Z + master-in-other Z + matching-branch Z + matching-tag Z + other/branch-in-other Z + other/master-in-other Z + EOF +' + +test_expect_success 'git checkout - a later --no-guess overrides previous checkout.guess = true, complete only refs' ' + test_config checkout.guess true && + test_completion "git checkout --no-guess " <<-\EOF + HEAD Z + master Z + matching-branch Z + matching-tag Z + other/branch-in-other Z + other/master-in-other Z + EOF +' + test_expect_success 'git switch - with --detach, complete all references' ' test_completion "git switch --detach " <<-\EOF HEAD Z