From patchwork Fri May 1 08:27:45 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Eric Sunshine X-Patchwork-Id: 11522291 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 2A6B214B4 for ; Fri, 1 May 2020 08:28:58 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 12C2F20731 for ; Fri, 1 May 2020 08:28:58 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="s89kkGKE" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728363AbgEAI25 (ORCPT ); Fri, 1 May 2020 04:28:57 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60094 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728325AbgEAI24 (ORCPT ); Fri, 1 May 2020 04:28:56 -0400 Received: from mail-qv1-xf42.google.com (mail-qv1-xf42.google.com [IPv6:2607:f8b0:4864:20::f42]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E2C8EC035494 for ; Fri, 1 May 2020 01:28:55 -0700 (PDT) Received: by mail-qv1-xf42.google.com with SMTP id q2so4440029qvd.1 for ; Fri, 01 May 2020 01:28:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=TCe2anMaGp0ftwfxStoPptHHrEsKH1LTILKwcUPC/ag=; b=s89kkGKEltVMfmGTKdcXIjBe0rmBu2f9bUI6pkVtmG1qJYdrxLVIxz7kee8W/SJ4t7 HpcyzcfU2kM8aR8aM5JMZhpe+3JIRnIH5kRXKXB7WvW3XVccuhy/vGFAe566BIamz9L5 mKo4ir7k+RR6SexruEs3YlcrEjTBPi2V/A1QkANj2lYIzI174Q2bzacd9U3jpbSYCIo3 EIXUnOOu0CbtdSGWSqKD40RifJMtI68r7jIIhf01SAWTWnQGw1meAI+K2nwqieGDOPkG holMFSkJt5pjqJ92/OKbn0NpjV3PzgrStboyZA0azzBFVDeP/UX9fGDJF5aeLvfeW+bz jx4A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=TCe2anMaGp0ftwfxStoPptHHrEsKH1LTILKwcUPC/ag=; b=dx8iwjPey3sdx/gKtUQg4hESEy9hCfnBk2itWKXuRcJArEiTN85izHPv2Q42w9vo+Q 40AQDhh1iEKPkwRXbojbE/jFAKyETEAFPEuf8b2i3agEXR/+HL0zVZUIWc5+u6BgflDB ldsNknIkEA15S/1an0iFi+3skr3becnaDTgXA0QP1FbDhpqFusekTxBmzFpPu5WyNH36 2cjkUHXSUBd8oytUFEGWxZgPfcfYlxVQm9u1pXGnvE7rMKhppZZtcUokyTowxSiENi3T v8voyBOQR9DJk8xJ0iimyotO6zNGuZ4cjTq/5RGA/BmD92L8l2pkH0SegkxbPh3KUxlc 2yXw== X-Gm-Message-State: AGi0PuZ6xKN36ka2hicCDRxw5RTvVSWmijDXlxr0nl6TdTyMAHpyUug1 /1I0tpoddUl2+rjlkBGxUw2+Msev X-Google-Smtp-Source: APiQypI00XKqpdxkT4LULy56bgXN+bEDdET5MLK5nviLzW+DM4OrI6TsJR4IL4NFqfpuaOYQ7SOm8g== X-Received: by 2002:a05:6214:122:: with SMTP id w2mr2940553qvs.165.1588321734686; Fri, 01 May 2020 01:28:54 -0700 (PDT) Received: from localhost.localdomain (user-12l2dpj.cable.mindspring.com. [69.81.55.51]) by smtp.gmail.com with ESMTPSA id 70sm2258138qkh.67.2020.05.01.01.28.53 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Fri, 01 May 2020 01:28:54 -0700 (PDT) From: Eric Sunshine To: git@vger.kernel.org Cc: =?utf-8?b?SGFycmkgTWVodMOkbMOk?= , Duy Nguyen , Eric Sunshine Subject: [PATCH 1/2] restore: require --source when combining --worktree and --staged Date: Fri, 1 May 2020 04:27:45 -0400 Message-Id: <20200501082746.23943-2-sunshine@sunshineco.com> X-Mailer: git-send-email 2.26.2.526.g744177e7f7 In-Reply-To: <20200501082746.23943-1-sunshine@sunshineco.com> References: <20200501082746.23943-1-sunshine@sunshineco.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The default restore source for --worktree is the index, and the default source for --staged is HEAD. When combining --worktree and --staged in the same invocation, the restore source is ambiguous ("should it restore from the index or from HEAD?"). To avoid such ambiguity, the git-restore documentation has always stated that --source must be used when combining --worktree and --staged. However, this restriction is not actually enforced. Address this deficiency by making the implementation match the documented behavior (to wit, error out if --source is not specified when combining --worktree and --staged). While at it, enhance the documentation to mention the --source requirement prominently in the "Description" section (rather than only in the description of the --source option itself). Reported-by: Harri Mehtälä Signed-off-by: Eric Sunshine --- Documentation/git-restore.txt | 3 ++- builtin/checkout.c | 3 +++ t/t2070-restore.sh | 5 +++++ 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index 8e3b339802..8906499637 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -24,7 +24,8 @@ The command can also be used to restore the content in the index with By default, the restore sources for working tree and the index are the index and `HEAD` respectively. `--source` could be used to specify a -commit as the restore source. +commit as the restore source; it is required when combining `--staged` +and `--worktree`. See "Reset, restore and revert" in linkgit:git[1] for the differences between the three commands. diff --git a/builtin/checkout.c b/builtin/checkout.c index 8bc94d392b..7a01d00f53 100644 --- a/builtin/checkout.c +++ b/builtin/checkout.c @@ -1604,6 +1604,9 @@ static int checkout_main(int argc, const char **argv, const char *prefix, } if (opts->checkout_index < 0 || opts->checkout_worktree < 0) BUG("these flags should be non-negative by now"); + if (opts->checkout_index > 0 && opts->checkout_worktree > 0 && + !opts->from_treeish) + die(_("--source required when using --worktree and --staged")); /* * convenient shortcut: "git restore --staged" equals * "git restore --staged --source HEAD" diff --git a/t/t2070-restore.sh b/t/t2070-restore.sh index 076d0df7fc..19efa21fdb 100755 --- a/t/t2070-restore.sh +++ b/t/t2070-restore.sh @@ -69,6 +69,11 @@ test_expect_success 'restore --staged uses HEAD as source' ' test_cmp expected actual ' +test_expect_success 'restore --worktree --staged requires --source' ' + test_must_fail git restore --worktree --staged first.t 2>err && + test_i18ngrep "source required when using --worktree and --staged" err +' + test_expect_success 'restore --ignore-unmerged ignores unmerged entries' ' git init unmerged && ( From patchwork Fri May 1 08:27:46 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Sunshine X-Patchwork-Id: 11522293 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 5C07D14B4 for ; Fri, 1 May 2020 08:28:59 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4456B20731 for ; Fri, 1 May 2020 08:28:59 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="NrOU6vjK" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728408AbgEAI26 (ORCPT ); Fri, 1 May 2020 04:28:58 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60102 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728325AbgEAI25 (ORCPT ); Fri, 1 May 2020 04:28:57 -0400 Received: from mail-qt1-x841.google.com (mail-qt1-x841.google.com [IPv6:2607:f8b0:4864:20::841]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3A0F5C035494 for ; Fri, 1 May 2020 01:28:57 -0700 (PDT) Received: by mail-qt1-x841.google.com with SMTP id x12so7392044qts.9 for ; Fri, 01 May 2020 01:28:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=IJgoyRbQ+0GbLq796pa73wc0vzevTPqPZHbe3hDCPnM=; b=NrOU6vjK3uHh1DKoYu9MYo3N7f1eCc0GVFX1k/9mWt1svB1u4xXKzOwqIJiuu4LTqf ZYUpZf1G5h4yUdc9TcPd49n06wXsWuClV5tLvROenGAQRBsvzuKjeTbBcF4HQ4Wo4fR1 uCvqY+Yk6Z5rZeOjselhmsc99556QncmyhHt+LfEF7oxxLWSgw8FluRcryvWItYR86gF Ho6Hiwb2ERMrPWd2NahGuXybHeHCVfFEg/WCUCvBZJlh3+2HEcr8ppuqd5dbQqfJvqy8 ILQCBKuBHo08xEH/qZFBD8hXjpvNJUvUGvAxa8wkAABw2fa1rqADKuYrQrxV598MjX6q Pi2A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=IJgoyRbQ+0GbLq796pa73wc0vzevTPqPZHbe3hDCPnM=; b=rIOBXMuBH03TI27G05xs67qt/jxGv8kZVOXEkPwm1YDmIG7gdOLBtcLs2yF3EC76cE t0zMGv4/e9iJTfOYKBNUPpzE2TGccX5XgUTx6E8Oc9MEkmmjOIshYB/IHL2Lla/IAFMP gUg1EEF+QKx52xCdDze3aYlQzGI1wbt9SVRqzc7IDd7auVpFwLghR1W/XS6X6vvJFEx1 7qaWGY6OdtyMlcISSrqZrRt9oByJ6WNwNkDi6/DrZUMX3BKd6+3F0sYHivQI58/oHA3W SIWF5En75EYG3sADGt1r3yUEX5Tynu4XKRrqdjkrPbtHAX6GPO0J3qSbWM5ohfEs0IEY nhEQ== X-Gm-Message-State: AGi0PuahJnfaZsfN0G4UHUMo15lxUHiNolPuwRMfGdLhEBrMEorHWhH+ H7B16OiH1sx8Qc0WrevzfcZlcU50 X-Google-Smtp-Source: APiQypJRZUT031H4FVXrPyz4bs7erwuzaYY5JwWs4NJWNq7m4vQoH8UVRHjxHvnFWF4nsvnYINsMdA== X-Received: by 2002:ac8:6ec8:: with SMTP id f8mr2498788qtv.330.1588321735973; Fri, 01 May 2020 01:28:55 -0700 (PDT) Received: from localhost.localdomain (user-12l2dpj.cable.mindspring.com. [69.81.55.51]) by smtp.gmail.com with ESMTPSA id 70sm2258138qkh.67.2020.05.01.01.28.54 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Fri, 01 May 2020 01:28:55 -0700 (PDT) From: Eric Sunshine To: git@vger.kernel.org Cc: =?utf-8?b?SGFycmkgTWVodMOkbMOk?= , Duy Nguyen , Eric Sunshine Subject: [PATCH 2/2] restore: default to HEAD when combining --worktree and --staged Date: Fri, 1 May 2020 04:27:46 -0400 Message-Id: <20200501082746.23943-3-sunshine@sunshineco.com> X-Mailer: git-send-email 2.26.2.526.g744177e7f7 In-Reply-To: <20200501082746.23943-1-sunshine@sunshineco.com> References: <20200501082746.23943-1-sunshine@sunshineco.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The default restore source for --worktree is the index, and the default source for --staged is HEAD. However, when combining --worktree and --staged in the same invocation, git-restore requires the source to be specified explicitly via --source since it would otherwise be ambiguous ("should it restore from the index or from HEAD?"). This requirement makes it cumbersome to restore a file in both the worktree and the index. However, HEAD is also a reasonably intuitive default restore source when --worktree and --staged are combined. After all, if a user is asking to throw away all local changes to a file (on disk and in the index) without specifying a restore source explicitly -- and the user expects the file to be restored from _somewhere_ -- then it is likely that the user expects them to be restored from HEAD, which is an intuitive and logical place to find a recent unadulterated copy of the file. Therefore, make HEAD the default restore source when --worktree and --staged are combined. Signed-off-by: Eric Sunshine --- Documentation/git-restore.txt | 14 +++++++------- builtin/checkout.c | 9 +++------ t/t2070-restore.sh | 12 +++++++++--- 3 files changed, 19 insertions(+), 16 deletions(-) diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index 8906499637..5b61812e17 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -22,10 +22,10 @@ The command can also be used to restore the content in the index with `--staged`, or restore both the working tree and the index with `--staged --worktree`. -By default, the restore sources for working tree and the index are the -index and `HEAD` respectively. `--source` could be used to specify a -commit as the restore source; it is required when combining `--staged` -and `--worktree`. +By default, the restore source for `--worktree` is the index, and the +restore source for `--staged` is `HEAD`. When combining `--worktree` and +`--staged`, the restore source is `HEAD`. `--source` can be used to specify +a different commit as the restore source. See "Reset, restore and revert" in linkgit:git[1] for the differences between the three commands. @@ -40,10 +40,10 @@ OPTIONS tree. It is common to specify the source tree by naming a commit, branch or tag associated with it. + -If not specified, the default restore source for the working tree is -the index, and the default restore source for the index is +If not specified, the default restore source for `--worktree` is +the index, and the default restore source for `--staged` is `HEAD`. When both `--staged` and `--worktree` are specified, -`--source` must also be specified. +the default restore source is `HEAD`. -p:: --patch:: diff --git a/builtin/checkout.c b/builtin/checkout.c index 7a01d00f53..500c3e23ff 100644 --- a/builtin/checkout.c +++ b/builtin/checkout.c @@ -1604,14 +1604,11 @@ static int checkout_main(int argc, const char **argv, const char *prefix, } if (opts->checkout_index < 0 || opts->checkout_worktree < 0) BUG("these flags should be non-negative by now"); - if (opts->checkout_index > 0 && opts->checkout_worktree > 0 && - !opts->from_treeish) - die(_("--source required when using --worktree and --staged")); /* - * convenient shortcut: "git restore --staged" equals - * "git restore --staged --source HEAD" + * convenient shortcut: "git restore --staged [--worktree]" equals + * "git restore --staged [--worktree] --source HEAD" */ - if (!opts->from_treeish && opts->checkout_index && !opts->checkout_worktree) + if (!opts->from_treeish && opts->checkout_index) opts->from_treeish = "HEAD"; /* diff --git a/t/t2070-restore.sh b/t/t2070-restore.sh index 19efa21fdb..89e5a142c9 100755 --- a/t/t2070-restore.sh +++ b/t/t2070-restore.sh @@ -69,9 +69,15 @@ test_expect_success 'restore --staged uses HEAD as source' ' test_cmp expected actual ' -test_expect_success 'restore --worktree --staged requires --source' ' - test_must_fail git restore --worktree --staged first.t 2>err && - test_i18ngrep "source required when using --worktree and --staged" err +test_expect_success 'restore --worktree --staged uses HEAD as source' ' + test_when_finished git reset --hard && + git show HEAD:./first.t >expected && + echo dirty >>first.t && + git add first.t && + git restore --worktree --staged first.t && + git show :./first.t >actual && + test_cmp expected actual && + test_cmp expected first.t ' test_expect_success 'restore --ignore-unmerged ignores unmerged entries' '