From patchwork Sun Apr 3 18:22:47 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "brian m. carlson" X-Patchwork-Id: 12799665 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 F268FC433EF for ; Sun, 3 Apr 2022 18:23:00 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1359747AbiDCSYv (ORCPT ); Sun, 3 Apr 2022 14:24:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41840 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1356696AbiDCSYt (ORCPT ); Sun, 3 Apr 2022 14:24:49 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [172.105.110.227]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7B97B39157 for ; Sun, 3 Apr 2022 11:22:55 -0700 (PDT) Received: from camp.crustytoothpaste.net (unknown [IPv6:2001:470:b056:101:a6ae:7d13:8741:9028]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by ring.crustytoothpaste.net (Postfix) with ESMTPSA id 8247F5A3E7; Sun, 3 Apr 2022 18:22:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649010174; bh=e1heZ5iu+vHK6AExECRdXfQJdgRLSg4U/ygA52vOhCU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From:Reply-To: Subject:Date:To:CC:Resent-Date:Resent-From:Resent-To:Resent-Cc: In-Reply-To:References:Content-Type:Content-Disposition; b=PjAmPpA89h5KBSSwzIGdRuB497faWcRBDW52ATYKHvZ2hahUtqRfwIbIvgnJF/GpO BYG9joPzpaPmuxsqBF2Izh312gqVNhwE53CTs+tDkyAjrDX1p64Dsed/iMpicE0P2V dU68upmdFPEB7MQE403QZlrFxjacPD3Cmo5ZjVdRGVGdWHw+EOybJG0MTKh/6TQepg NjTPSxlTSoYi/Ja8FDMmfqWhcdK16sM6s11DlihE6guUJALIrcP/mvFV55/oMCz7ZO Ykx9wjm0iBoAlhOU0itD5Xed7/knwjkrAJ/IywN/Bxqvz0ilTa6vgamXa7yElGnU6X tqW3Erwc4yrbkVderk4S6VymUmQtJ7p8MQ8eReHE4ZgpqzA6KAVt/0jVtRAS6RcQ5W txQkne505s+FWd6iokab7YxlS1YqDXgt1GctKbbGUwesv3M/9a01QFnm9bTqUMLKes 2e5LINVbTG3eHM9IvM6H2S/Vjz7nqY7HsS7h7hEWdt7MEpsrben From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v3 1/4] object-name: make get_oid quietly return an error Date: Sun, 3 Apr 2022 18:22:47 +0000 Message-Id: <20220403182250.904933-2-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220403182250.904933-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220403182250.904933-1-sandals@crustytoothpaste.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org A reasonable person looking at the signature and usage of get_oid and friends might conclude that in the event of an error, it always returns -1. However, this is not the case. Instead, get_oid_basic dies if we go too far back into the history of a reflog (or, when quiet, simply exits). This is not especially useful, since in many cases, we might want to handle this error differently. Let's add a flag here to make it just return -1 like elsewhere in these code paths. Note that we cannot make this behavior the default, since we have many other codepaths that rely on the existing behavior, including in tests. Signed-off-by: brian m. carlson --- cache.h | 1 + object-name.c | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/cache.h b/cache.h index 825ec17198..657e3ff17f 100644 --- a/cache.h +++ b/cache.h @@ -1376,6 +1376,7 @@ struct object_context { #define GET_OID_RECORD_PATH 0200 #define GET_OID_ONLY_TO_DIE 04000 #define GET_OID_REQUIRE_PATH 010000 +#define GET_OID_GENTLY 020000 #define GET_OID_DISAMBIGUATORS \ (GET_OID_COMMIT | GET_OID_COMMITTISH | \ diff --git a/object-name.c b/object-name.c index 92862eeb1a..46dbfe36a6 100644 --- a/object-name.c +++ b/object-name.c @@ -911,13 +911,17 @@ static int get_oid_basic(struct repository *r, const char *str, int len, len, str, show_date(co_time, co_tz, DATE_MODE(RFC2822))); } - } else { + } else if (!(flags & GET_OID_GENTLY)) { if (flags & GET_OID_QUIETLY) { exit(128); } die(_("log for '%.*s' only has %d entries"), len, str, co_cnt); } + if (flags & GET_OID_GENTLY) { + free(real_ref); + return -1; + } } } From patchwork Sun Apr 3 18:22:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "brian m. carlson" X-Patchwork-Id: 12799666 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 D7B62C433EF for ; Sun, 3 Apr 2022 18:23:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1359748AbiDCSYy (ORCPT ); Sun, 3 Apr 2022 14:24:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41838 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1359739AbiDCSYt (ORCPT ); Sun, 3 Apr 2022 14:24:49 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [172.105.110.227]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 602C5344CF for ; Sun, 3 Apr 2022 11:22:55 -0700 (PDT) Received: from camp.crustytoothpaste.net (unknown [IPv6:2001:470:b056:101:a6ae:7d13:8741:9028]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by ring.crustytoothpaste.net (Postfix) with ESMTPSA id 8FB545A3E9; Sun, 3 Apr 2022 18:22:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649010174; bh=CPomXpIHqKBhTF6pLDNs9s22y3itA/jk84LgRY+Fkc0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From:Reply-To: Subject:Date:To:CC:Resent-Date:Resent-From:Resent-To:Resent-Cc: In-Reply-To:References:Content-Type:Content-Disposition; b=kjc8503oKXrUPX6w8STLIp9YGAdHKfjShWUnQVb/f2H6cyvLajKAByJCUNOB36T/1 4MEU/mQjrU7Df4KMW1NT9ESXqYiQ3BQmO95tXx6d8a0gfhqbf6BY1NUMVEsI5WQJm5 lVDO8czM7a6IuC/+ZVHycTA3CTJNEUhwzJ97mLaHdL9VEPy+fhlCK72JKGqfu22Ng4 tT7/KHpNoUvtTjlScZ0tfXYEMh/LeCZ65HT91K7tSPDhmyYaxcMyT+NqAFrwq54YMO V9KI4CUS/MIuU5BGaNuHo4ZOKa2Ydx6saHCTRHtRUGSpm1iCVCMfexsbn1swPKVr9/ FO0lZ5RS9YqKDUM0MhSPBEQsQJ8CXzcrdku6b4MhUe3Kd7wFXcboB1+nmXnBn2NSwE 9ZeCepOFFya0IJFR9/vccCIQ5cmorBdtouN3eKb5ZpllKpplP2T2zpLJ89sMafgd8q i9TX3tI+WLZsfo0m2CzM8IgQf3bF8VXjuSfs+jXavCYIN13X7WT From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v3 2/4] builtin/stash: factor out revision parsing into a function Date: Sun, 3 Apr 2022 18:22:48 +0000 Message-Id: <20220403182250.904933-3-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220403182250.904933-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220403182250.904933-1-sandals@crustytoothpaste.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org We allow several special forms of stash names in this code. In the future, we'll want to allow these same forms without parsing a stash commit, so let's refactor this code out into a function for reuse. Signed-off-by: brian m. carlson --- builtin/stash.c | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/builtin/stash.c b/builtin/stash.c index 5897febfbe..4c281a5781 100644 --- a/builtin/stash.c +++ b/builtin/stash.c @@ -130,6 +130,24 @@ static void assert_stash_like(struct stash_info *info, const char *revision) die(_("'%s' is not a stash-like commit"), revision); } +static int parse_revision(struct strbuf *revision, const char *commit, int quiet) +{ + strbuf_init(revision, 0); + if (!commit) { + if (!ref_exists(ref_stash)) { + fprintf_ln(stderr, _("No stash entries found.")); + return -1; + } + + strbuf_addf(revision, "%s@{0}", ref_stash); + } else if (strspn(commit, "0123456789") == strlen(commit)) { + strbuf_addf(revision, "%s@{%s}", ref_stash, commit); + } else { + strbuf_addstr(revision, commit); + } + return 0; +} + static int get_stash_info(struct stash_info *info, int argc, const char **argv) { int ret; @@ -157,19 +175,9 @@ static int get_stash_info(struct stash_info *info, int argc, const char **argv) if (argc == 1) commit = argv[0]; - strbuf_init(&info->revision, 0); - if (!commit) { - if (!ref_exists(ref_stash)) { - free_stash_info(info); - fprintf_ln(stderr, _("No stash entries found.")); - return -1; - } - - strbuf_addf(&info->revision, "%s@{0}", ref_stash); - } else if (strspn(commit, "0123456789") == strlen(commit)) { - strbuf_addf(&info->revision, "%s@{%s}", ref_stash, commit); - } else { - strbuf_addstr(&info->revision, commit); + if (parse_revision(&info->revision, commit, 0)) { + free_stash_info(info); + return -1; } revision = info->revision.buf; From patchwork Sun Apr 3 18:22:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "brian m. carlson" X-Patchwork-Id: 12799668 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 6A6FDC433EF for ; Sun, 3 Apr 2022 18:23:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1359756AbiDCSY6 (ORCPT ); Sun, 3 Apr 2022 14:24:58 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41846 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1359742AbiDCSYu (ORCPT ); Sun, 3 Apr 2022 14:24:50 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [172.105.110.227]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7B7B838BC7 for ; Sun, 3 Apr 2022 11:22:55 -0700 (PDT) Received: from camp.crustytoothpaste.net (unknown [IPv6:2001:470:b056:101:a6ae:7d13:8741:9028]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by ring.crustytoothpaste.net (Postfix) with ESMTPSA id 9D3AB5A3EA; Sun, 3 Apr 2022 18:22:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649010174; bh=uTc3srZhypW8DHhObDqqm7vRXu/3ewVAdnhVKtVu93I=; h=From:To:Cc:Subject:Date:In-Reply-To:References:Content-Type:From: Reply-To:Subject:Date:To:CC:Resent-Date:Resent-From:Resent-To: Resent-Cc:In-Reply-To:References:Content-Type:Content-Disposition; b=j79rSGcEmrhlico1ymzMnUTmiYVEGOBsnS0zKREdMZSs4fjgDGXvBycP1MtXbXVGx y7NKnCs7amNrHprb7X56oPuVHqRiRD/AbNXhuNCJJyJOwhx3TN3oIL3ewBL8UOIrsm pb9NsaeBImN/1HegBXnexDViLhvbmnMYBDfQV5ndEsEoTXdX4HQYxsf4EQyHjltqk3 /Jx08bW+pnL9L4u1s8gLXpPi/wwmTXYe36dQBvXtft+R3KgjNgRlEGwpjC87OJrCpP GNeHn0ASZ5LCEQq1jS9Iu8t2T97UqF8voEXAAFwV3O2gHF/T3sTudjstqtKvS4YcuV HU18VFFi0Z+LVFReJGpgiaR95GpYATawc1N/T3Gtys05WGvSRev3Fdtg03RnehOfiT R/kERzRVzrKUA7owBgEQMlq7Q2cg6Uu//ABETYSHANd/rd1WkSi8dmMvwwc8jnuVMz yUyfD3cB+yBfc4GRg8p5xSukC1QWXKQWmBeXJ77D7trskGHTX/B From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v3 3/4] builtin/stash: provide a way to export stashes to a ref Date: Sun, 3 Apr 2022 18:22:49 +0000 Message-Id: <20220403182250.904933-4-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220403182250.904933-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220403182250.904933-1-sandals@crustytoothpaste.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org A common user problem is how to sync in-progress work to another machine. Users currently must use some sort of transfer of the working tree, which poses security risks and also necessarily causes the index to become dirty. The experience is suboptimal and frustrating for users. A reasonable idea is to use the stash for this purpose, but the stash is stored in the reflog, not in a ref, and as such it cannot be pushed or pulled. This also means that it cannot be saved into a bundle or preserved elsewhere, which is a problem when using throwaway development environments. Let's solve this problem by allowing the user to export the stash to a ref (or, to just write it into the repository and print the hash, à la git commit-tree). Introduce git stash export, which writes a chain of commits where the first parent is always a chain to the previous stash, or to a single, empty commit (for the final item) and the second is the stash commit normally written to the reflog. Iterate over each stash from topmost to bottomost, looking up the data for each one, and then create the chain from the single empty commit back up in reverse order. Generate a predictable empty commit so our behavior is reproducible. Create a useful commit message, preserving the author and committer information, to help users identify stash commits when viewing them as normal commits. If the user has specified specific stashes they'd like to export instead, use those instead of iterating over all of the stashes. As part of this, specifically request quiet behavior when looking up the OID for a revision because we will eventually hit a revision that doesn't exist and we don't want to die when that occurs. Signed-off-by: brian m. carlson --- Documentation/git-stash.txt | 22 ++++- builtin/stash.c | 184 ++++++++++++++++++++++++++++++++++++ 2 files changed, 205 insertions(+), 1 deletion(-) diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 6e15f47525..162110314e 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -20,6 +20,7 @@ SYNOPSIS 'git stash' clear 'git stash' create [] 'git stash' store [-m|--message ] [-q|--quiet] +'git stash' export ( --print | --to-ref ) [...] DESCRIPTION ----------- @@ -151,6 +152,12 @@ store:: reflog. This is intended to be useful for scripts. It is probably not the command you want to use; see "push" above. +export ( --print | --to-ref ) [...]:: + + Export the specified stashes, or all of them if none are specified, to + a chain of commits which can be transferred using the normal fetch and + push mechanisms, then imported using the `import` subcommand. + OPTIONS ------- -a:: @@ -239,6 +246,19 @@ literally (including newlines and quotes). + Quiet, suppress feedback messages. +--print:: + This option is only valid for `export`. ++ +Create the chain of commits representing the exported stashes without +storing it anywhere in the ref namespace and print the object ID to +standard output. This is designed for scripts. + +--to-ref:: + This option is only valid for `export`. ++ +Create the chain of commits representing the exported stashes and store +it to the specified ref. + \--:: This option is only valid for `push` command. + @@ -256,7 +276,7 @@ For more details, see the 'pathspec' entry in linkgit:gitglossary[7]. :: This option is only valid for `apply`, `branch`, `drop`, `pop`, - `show` commands. + `show`, and `export` commands. + A reference of the form `stash@{}`. When no `` is given, the latest stash is assumed (that is, `stash@{0}`). diff --git a/builtin/stash.c b/builtin/stash.c index 4c281a5781..89e22d0cdd 100644 --- a/builtin/stash.c +++ b/builtin/stash.c @@ -33,6 +33,7 @@ static const char * const git_stash_usage[] = { " [--] [...]]"), N_("git stash save [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-q|--quiet]\n" " [-u|--include-untracked] [-a|--all] []"), + N_("git stash export (--print | --to-ref ) [...]"), NULL }; @@ -89,6 +90,12 @@ static const char * const git_stash_save_usage[] = { NULL }; +static const char * const git_stash_export_usage[] = { + N_("git stash export (--print | --to-ref ) [...]"), + NULL +}; + + static const char ref_stash[] = "refs/stash"; static struct strbuf stash_index_path = STRBUF_INIT; @@ -1773,6 +1780,181 @@ static int save_stash(int argc, const char **argv, const char *prefix) return ret; } +static int write_commit_with_parents(struct object_id *out, const struct object_id *oid, struct commit_list *parents) +{ + size_t author_len, committer_len; + struct commit *this; + const char *orig_author, *orig_committer; + char *author = NULL, *committer = NULL; + const char *buffer; + unsigned long bufsize; + const char *p; + struct strbuf msg = STRBUF_INIT; + int ret = 0; + + this = lookup_commit_reference(the_repository, oid); + buffer = get_commit_buffer(this, &bufsize); + orig_author = find_commit_header(buffer, "author", &author_len); + orig_committer = find_commit_header(buffer, "committer", &committer_len); + p = memmem(buffer, bufsize, "\n\n", 2); + + if (!orig_author || !orig_committer || !p) { + error(_("cannot parse commit %s"), oid_to_hex(oid)); + goto out; + } + /* Jump to message. */ + p += 2; + strbuf_addstr(&msg, "git stash: "); + strbuf_add(&msg, p, bufsize - (p - buffer)); + + author = xmemdupz(orig_author, author_len); + committer = xmemdupz(orig_committer, committer_len); + + if (commit_tree_extended(msg.buf, msg.len, + the_hash_algo->empty_tree, parents, + out, author, committer, + NULL, NULL)) { + ret = -1; + error(_("could not write commit")); + goto out; + } +out: + strbuf_reset(&msg); + unuse_commit_buffer(this, buffer); + free(author); + free(committer); + return ret; +} + +static int do_export_stash(const char *ref, size_t argc, const char **argv) +{ + struct object_id base; + struct object_context unused; + struct commit *prev; + struct object_id *items = NULL; + int nitems = 0, nalloc = 0; + int res = 0; + int i; + struct strbuf revision = STRBUF_INIT; + const char *author, *committer; + + /* + * This is an arbitrary, fixed date, specifically the one used by git + * format-patch. The goal is merely to produce reproducible output. + */ + prepare_fallback_ident("git stash", "git@stash"); + author = fmt_ident("git stash", "git@stash", WANT_BLANK_IDENT, "2001-09-17T00:00:00Z", 0); + committer = fmt_ident("git stash", "git@stash", WANT_BLANK_IDENT, "2001-09-17T00:00:00Z", 0); + + /* First, we create a single empty commit. */ + if (commit_tree_extended(NULL, 0, the_hash_algo->empty_tree, NULL, &base, author, committer, NULL, NULL)) + return error(_("unable to write base commit")); + + prev = lookup_commit_reference(the_repository, &base); + + if (argc) { + /* + * Find each specified stash, and load data into the array. + */ + for (i = 0; i < argc; i++) { + ALLOC_GROW_BY(items, nitems, 1, nalloc); + if (parse_revision(&revision, argv[i], 0) || + get_oid_with_context(the_repository, revision.buf, + GET_OID_QUIETLY | GET_OID_GENTLY, + &items[i], &unused)) { + error(_("unable to find stash entry %s"), argv[i]); + res = -1; + goto out; + } + } + } else { + /* + * Walk the reflog, finding each stash entry, and load data into the + * array. + */ + for (i = 0;; i++) { + char buf[32]; + struct object_id oid; + + snprintf(buf, sizeof(buf), "%d", i); + if (parse_revision(&revision, buf, 1) || + get_oid_with_context(the_repository, revision.buf, + GET_OID_QUIETLY | GET_OID_GENTLY, + &oid, &unused)) + break; + ALLOC_GROW_BY(items, nitems, 1, nalloc); + oidcpy(&items[i], &oid); + } + } + + /* + * Now, create a set of commits identical to the regular stash commits, + * but where their first parents form a chain to our original empty + * base commit. + */ + for (i = nitems - 1; i >= 0; i--) { + struct commit_list *parents = NULL; + struct commit_list **next = &parents; + struct object_id out; + + next = commit_list_append(prev, next); + next = commit_list_append(lookup_commit_reference(the_repository, &items[i]), next); + if (write_commit_with_parents(&out, &items[i], parents)) { + res = -1; + goto out; + } + prev = lookup_commit_reference(the_repository, &out); + } + if (ref) + update_ref(NULL, ref, &prev->object.oid, NULL, 0, UPDATE_REFS_DIE_ON_ERR); + else + puts(oid_to_hex(&prev->object.oid)); +out: + free(items); + + return res; +} + +enum export_action { + ACTION_NONE, + ACTION_PRINT, + ACTION_TO_REF, +}; + +static int export_stash(int argc, const char **argv, const char *prefix) +{ + int ret = 0; + const char *ref = NULL; + enum export_action action = ACTION_NONE; + struct option options[] = { + OPT_CMDMODE(0, "print", &action, + N_("print the object ID instead of writing it to a ref"), + ACTION_PRINT), + OPT_CMDMODE(0, "to-ref", &action, + N_("save the data to the given ref"), + ACTION_TO_REF), + OPT_END() + }; + + argc = parse_options(argc, argv, prefix, options, + git_stash_export_usage, + PARSE_OPT_KEEP_DASHDASH); + + if (action == ACTION_NONE) { + return error(_("exactly one of --print and --to-ref is required")); + } else if (action == ACTION_TO_REF) { + if (!argc) + return error(_("--to-ref requires an argument")); + ref = argv[0]; + argc--; + argv++; + } + + + ret = do_export_stash(ref, argc, argv); + return ret; +} + int cmd_stash(int argc, const char **argv, const char *prefix) { pid_t pid = getpid(); @@ -1816,6 +1998,8 @@ int cmd_stash(int argc, const char **argv, const char *prefix) return !!push_stash(argc, argv, prefix, 0); else if (!strcmp(argv[0], "save")) return !!save_stash(argc, argv, prefix); + else if (!strcmp(argv[0], "export")) + return !!export_stash(argc, argv, prefix); else if (*argv[0] != '-') usage_msg_optf(_("unknown subcommand: %s"), git_stash_usage, options, argv[0]); From patchwork Sun Apr 3 18:22:50 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "brian m. carlson" X-Patchwork-Id: 12799667 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 A82DDC433F5 for ; Sun, 3 Apr 2022 18:23:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1359754AbiDCSY5 (ORCPT ); Sun, 3 Apr 2022 14:24:57 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41844 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1359741AbiDCSYu (ORCPT ); Sun, 3 Apr 2022 14:24:50 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [IPv6:2600:3c04::f03c:92ff:fe9e:c6d8]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7B750344D1 for ; Sun, 3 Apr 2022 11:22:55 -0700 (PDT) Received: from camp.crustytoothpaste.net (unknown [IPv6:2001:470:b056:101:a6ae:7d13:8741:9028]) (using TLSv1.2 with cipher ECDHE-RSA-CHACHA20-POLY1305 (256/256 bits)) (No client certificate requested) by ring.crustytoothpaste.net (Postfix) with ESMTPSA id B061F5A3EB; Sun, 3 Apr 2022 18:22:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649010174; bh=7iPBuR3wtPemFXqruLNpI0UpKKQtSK/F6Oia6R5EsGk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From:Reply-To: Subject:Date:To:CC:Resent-Date:Resent-From:Resent-To:Resent-Cc: In-Reply-To:References:Content-Type:Content-Disposition; b=VtB9wciaxRd6LeWDnq9wOXjtt+zjBThdoQjU3BFWPuHXj4HIK+xpX1678fjK97MMu prwxBct7p3t+A1CFYk2rbJ0Vsf24Dk6oLWsLhzsAICOfw28BXfoTyMX2g+PY2djTw3 rGZJIFi6XoyiguGGmc9BAcWoaZ1KiAKmLFp/J8ND73rvMoX3nzrxx8OOyImfNCsckM jvzEo8z0TzhS3UmHX+wvUnsm91weaO588Drg3D/ML2JtoeFZxu6edRS7J8DJqC/Jgf 0BjsHeSyvxsEt7aNZDCec2heqiBT6ZZlarf2+O7UHOBNTzFeiYxUPUGWY+UGAPFgfx EFx2rZCLgG5PbnSCGf0aOYwX0+wzzbo+Ts9odwV/rvqP1OE7UtlfntUGn4MfpNsSwd +NTVm/44JpJ8rWwduSWnHU+MoJyMhd8vkg0khx7LXOZFDjki0WWIVDEX14rewh19ox Ocgm5TBOTOKSsswwvt4VS++Yj3BGrTfqL26Mc4oVWb3Gd6NLDtj From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v3 4/4] builtin/stash: provide a way to import stashes from a ref Date: Sun, 3 Apr 2022 18:22:50 +0000 Message-Id: <20220403182250.904933-5-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220403182250.904933-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220403182250.904933-1-sandals@crustytoothpaste.net> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Now that we have a way to export stashes to a ref, let's provide a way to import them from such a ref back to the stash. This works much the way the export code does, except that we strip off the first parent chain commit and then store each resulting commit back to the stash. We don't clear the stash first and instead add the specified stashes to the top of the stash. This is because users may want to export just a few stashes, such as to share a small amount of work in progress with a colleague, and it would be undesirable for the receiving user to lose all of their data. For users who do want to replace the stash, it's easy to do to: simply run "git stash clear" first. We specifically rely on the fact that we'll produce identical stash commits on both sides in our tests. This provides a cheap, straightforward check for our tests and also makes it easy for users to see if they already have the same data in both repositories. Signed-off-by: brian m. carlson --- Documentation/git-stash.txt | 7 +++ builtin/stash.c | 108 ++++++++++++++++++++++++++++++++++++ t/t3903-stash.sh | 52 +++++++++++++++++ 3 files changed, 167 insertions(+) diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 162110314e..28eb9cab0c 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -21,6 +21,7 @@ SYNOPSIS 'git stash' create [] 'git stash' store [-m|--message ] [-q|--quiet] 'git stash' export ( --print | --to-ref ) [...] +'git stash' import DESCRIPTION ----------- @@ -158,6 +159,12 @@ export ( --print | --to-ref ) [...]:: a chain of commits which can be transferred using the normal fetch and push mechanisms, then imported using the `import` subcommand. +import :: + + Import the specified stashes from the specified commit, which must have been + created by `export`, and add them to the list of stashes. To replace the + existing stashes, use `clear` first. + OPTIONS ------- -a:: diff --git a/builtin/stash.c b/builtin/stash.c index 89e22d0cdd..93b1a996c4 100644 --- a/builtin/stash.c +++ b/builtin/stash.c @@ -34,6 +34,7 @@ static const char * const git_stash_usage[] = { N_("git stash save [-p|--patch] [-S|--staged] [-k|--[no-]keep-index] [-q|--quiet]\n" " [-u|--include-untracked] [-a|--all] []"), N_("git stash export (--print | --to-ref ) [...]"), + N_("git stash import "), NULL }; @@ -95,6 +96,10 @@ static const char * const git_stash_export_usage[] = { NULL }; +static const char * const git_stash_import_usage[] = { + N_("git stash import "), + NULL +}; static const char ref_stash[] = "refs/stash"; static struct strbuf stash_index_path = STRBUF_INIT; @@ -104,6 +109,7 @@ static struct strbuf stash_index_path = STRBUF_INIT; * b_commit is set to the base commit * i_commit is set to the commit containing the index tree * u_commit is set to the commit containing the untracked files tree + * c_commit is set to the first parent (chain commit) when importing and is otherwise unset * w_tree is set to the working tree * b_tree is set to the base tree * i_tree is set to the index tree @@ -114,6 +120,7 @@ struct stash_info { struct object_id b_commit; struct object_id i_commit; struct object_id u_commit; + struct object_id c_commit; struct object_id w_tree; struct object_id b_tree; struct object_id i_tree; @@ -1826,6 +1833,105 @@ static int write_commit_with_parents(struct object_id *out, const struct object_ return ret; } +static int do_import_stash(const char *rev) +{ + struct object_id chain; + size_t nalloc = 0; + struct object_id *items = NULL; + int nitems = 0; + int res = 0; + int i; + const char *buffer = NULL; + struct commit *this = NULL; + char *msg = NULL; + + if (get_oid(rev, &chain)) + return error(_("not a valid revision: %s"), rev); + + /* + * Walk the commit history, finding each stash entry, and load data into + * the array. + */ + for (i = 0;; i++) { + struct object_id tree, oid; + char revision[GIT_MAX_HEXSZ + 1]; + + oid_to_hex_r(revision, &chain); + + if (get_oidf(&tree, "%s:", revision) || + !oideq(&tree, the_hash_algo->empty_tree)) { + return error(_("%s is not a valid exported stash commit"), revision); + } + if (get_oidf(&chain, "%s^1", revision) || + get_oidf(&oid, "%s^2", revision)) + break; + ALLOC_GROW_BY(items, nitems, 1, nalloc); + oidcpy(&items[i], &oid); + } + + /* + * Now, walk each entry, adding it to the stash as a normal stash + * commit. + */ + for (i = nitems - 1; i >= 0; i--) { + unsigned long bufsize; + const char *p; + + this = lookup_commit_reference(the_repository, &items[i]); + buffer = get_commit_buffer(this, &bufsize); + if (!buffer) { + res = -1; + error(_("cannot read commit buffer for %s"), oid_to_hex(&items[i])); + goto out; + } + + p = memmem(buffer, bufsize, "\n\n", 2); + if (!p) { + res = -1; + error(_("cannot parse commit %s"), oid_to_hex(&items[i])); + goto out; + } + + p += 2; + msg = xmemdupz(p, bufsize - (p - buffer)); + unuse_commit_buffer(this, buffer); + buffer = NULL; + + if (do_store_stash(&items[i], msg, 1)) { + res = -1; + error(_("cannot save the stash for %s"), oid_to_hex(&items[i])); + goto out; + } + FREE_AND_NULL(msg); + } +out: + if (this && buffer) + unuse_commit_buffer(this, buffer); + free(items); + free(msg); + + return res; +} + +static int import_stash(int argc, const char **argv, const char *prefix) +{ + int ret = 0; + struct option options[] = { + OPT_END() + }; + + argc = parse_options(argc, argv, prefix, options, + git_stash_import_usage, + PARSE_OPT_KEEP_DASHDASH); + + if (argc != 1) + return error(_("a revision to import from is required")); + + + ret = do_import_stash(argv[0]); + return ret; +} + static int do_export_stash(const char *ref, size_t argc, const char **argv) { struct object_id base; @@ -2000,6 +2106,8 @@ int cmd_stash(int argc, const char **argv, const char *prefix) return !!save_stash(argc, argv, prefix); else if (!strcmp(argv[0], "export")) return !!export_stash(argc, argv, prefix); + else if (!strcmp(argv[0], "import")) + return !!import_stash(argc, argv, prefix); else if (*argv[0] != '-') usage_msg_optf(_("unknown subcommand: %s"), git_stash_usage, options, argv[0]); diff --git a/t/t3903-stash.sh b/t/t3903-stash.sh index b149e2af44..d2ddede9be 100755 --- a/t/t3903-stash.sh +++ b/t/t3903-stash.sh @@ -1295,6 +1295,58 @@ test_expect_success 'stash --keep-index with file deleted in index does not resu test_path_is_missing to-remove ' +test_expect_success 'stash export and import round-trip stashes' ' + git reset && + >untracked && + >tracked1 && + >tracked2 && + git add tracked* && + git stash -- && + >subdir/untracked && + >subdir/tracked1 && + >subdir/tracked2 && + git add subdir/tracked* && + git stash -- subdir/ && + stash0=$(git rev-parse --verify stash@{0}) && + stash1=$(git rev-parse --verify stash@{1}) && + simple=$(git stash export --print) && + git stash clear && + git stash import "$simple" && + imported0=$(git rev-parse --verify stash@{0}) && + imported1=$(git rev-parse --verify stash@{1}) && + test "$imported0" = "$stash0" && + test "$imported1" = "$stash1" && + git stash export --to-ref refs/heads/foo && + git stash clear && + git stash import foo && + imported0=$(git rev-parse --verify stash@{0}) && + imported1=$(git rev-parse --verify stash@{1}) && + test "$imported0" = "$stash0" && + test "$imported1" = "$stash1" +' + +test_expect_success 'stash import appends commits' ' + git log --format=oneline -g refs/stash >actual && + echo $(cat actual | wc -l) >count && + git stash import refs/heads/foo && + git log --format=oneline -g refs/stash >actual && + test_line_count = $(($(cat count) * 2)) actual +' + +test_expect_success 'stash export can accept specified stashes' ' + git stash clear && + git stash import foo && + git stash export --to-ref bar stash@{1} stash@{0} && + git stash clear && + git stash import bar && + imported0=$(git rev-parse --verify stash@{0}) && + imported1=$(git rev-parse --verify stash@{1}) && + test "$imported1" = "$stash0" && + test "$imported0" = "$stash1" && + git log --format=oneline -g refs/stash >actual && + test_line_count = 2 actual +' + test_expect_success 'stash apply should succeed with unmodified file' ' echo base >file && git add file &&