From patchwork Thu Apr 7 21:53:49 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: 12805830 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 1A279C433EF for ; Thu, 7 Apr 2022 22:08:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231845AbiDGWK2 (ORCPT ); Thu, 7 Apr 2022 18:10:28 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47950 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231523AbiDGWKY (ORCPT ); Thu, 7 Apr 2022 18:10:24 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [172.105.110.227]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5F075140F0 for ; Thu, 7 Apr 2022 14:54:00 -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 E7BC55A3EE; Thu, 7 Apr 2022 21:53:59 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649368439; 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=D+upvuSCdtpduXa6njhkkYSzvrmp4r9df29mGohvMVRCdLzPihRnp97lKfGHQwd0y pikHaR8DB4z0rJP5ZVWkiTnDVzIPrhfahTMf++4M/J+0QZwg2owwPtL83NGzwrxCNT 7yeGqHJEHUpwXagHBHnbAaoLjrX/o6a7hKgZR6xDYdo0uxC1lZu458ZmTIjBEFPM7n kaCETmhBp7aYvK7hp4QNVWH1H402ZksEGC0b/EaDhmQoav2x4NsfQ84ph36W684yFq gp2OTuNozLb8RtF2o/2S9GRBuDu/s/UrEFti1bwKQANCYmjauP2PO/8WExZcsBK4LB G3JlkK6oeb6S0kX938tcsr45yiTafn5iGxns1/HslsWMdnj1Y7mFQ4nEmwNZG0SJ9x 1a1aOMVCVq19oDTCL3zWOd7wMC5OUXVzRztynbV6uhyFmZ/b8cccVv0ieAk60I5N84 8KV5r4qLytft560dOBijE0miLvXNFN0RVmOd1X7MkMVsq1kdJ7O From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v4 1/4] object-name: make get_oid quietly return an error Date: Thu, 7 Apr 2022 21:53:49 +0000 Message-Id: <20220407215352.3491567-2-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220407215352.3491567-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220407215352.3491567-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 Thu Apr 7 21:53: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: 12805831 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 652D7C4332F for ; Thu, 7 Apr 2022 22:08:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231928AbiDGWK1 (ORCPT ); Thu, 7 Apr 2022 18:10:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47944 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230432AbiDGWKY (ORCPT ); Thu, 7 Apr 2022 18:10:24 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [IPv6:2600:3c04::f03c:92ff:fe9e:c6d8]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3C14EFD02 for ; Thu, 7 Apr 2022 14:54:00 -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 F337B5A3EF; Thu, 7 Apr 2022 21:53:59 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649368440; bh=GdN4t1Nz5HD/v1HvYj0+FKY9QXq91HQKGVBU/wwyg7M=; 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=B1i422pQXAWZ/hAbIBn8aGcKT71p/3cgrY+ShBllXPVkE8SSlNXX0zPKorPeOVIdC ZgZ6Sy8iqRVcETZDdDZZJ7tUaFZ44osFI+gmX71jMn+wIiDAwJXEGmN8UKILcOcQbz uFEMMLsWK8ebW8X/uQCTgkXYKbP3+KbDnxuadSlTud9KhCMZFT0FDUxGu3xshz4/XN bfFL3tsQdwIn+2EFJdhxNQMD4DmMvGd/rjdQLClt2hXYK58/EVPKaMB6pyF+FSGzW8 sqJeNg07FWlQz/rBNuiNymbPAsGhymWRIv2r8jaE+Ib4WUoMeA+tTo5+5Lj2+XrDUh ELLiFgH0QCA5QarqdXzNMePSQW6ZxD3/Bbz8cPr1KYHKORyXb696ISzxj3PVYdxGiv RVN1MHO/W06cyVcMDinZnbsqOnMCxxW+dpJM8eVHMQHXq6KE8azrdI7AYiTnSkutSk lMT3LzyHxj9jo+YHURgBpCS6Pvr6CdY7MMDutJqAphQdwsJAYKs From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v4 2/4] builtin/stash: factor out revision parsing into a function Date: Thu, 7 Apr 2022 21:53:50 +0000 Message-Id: <20220407215352.3491567-3-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220407215352.3491567-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220407215352.3491567-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, 22 insertions(+), 12 deletions(-) diff --git a/builtin/stash.c b/builtin/stash.c index 5897febfbe..b677739bcd 100644 --- a/builtin/stash.c +++ b/builtin/stash.c @@ -130,6 +130,25 @@ 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_reset(revision); + if (!commit) { + if (!ref_exists(ref_stash)) { + if (!quiet) + 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; @@ -158,18 +177,9 @@ static int get_stash_info(struct stash_info *info, int argc, const char **argv) 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 Thu Apr 7 21:53:51 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: 12805829 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 AEFCBC433F5 for ; Thu, 7 Apr 2022 22:08:27 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231883AbiDGWKZ (ORCPT ); Thu, 7 Apr 2022 18:10:25 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47930 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230128AbiDGWKY (ORCPT ); Thu, 7 Apr 2022 18:10:24 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [IPv6:2600:3c04::f03c:92ff:fe9e:c6d8]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E047FE0BC for ; Thu, 7 Apr 2022 14:54:00 -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 0AF815A3F1; Thu, 7 Apr 2022 21:54:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649368440; bh=mDGuLV8bLSKzdfGvYq1Uk8ncGktMtJirKeEWCm2o+Aw=; 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=Xk+tQDLdJKsDcH2t2qJhfMnkzlOkSpi2s9BK/r53r8m4TxkCCps+YukgD1WN9UCvV InW+f+2QoaiYmfGuxeKZrZPWOBjm9oQeaKnlqb/iLh6v4aqA1IX7xBnxFTZ1z7DkQ6 JlyJbA3+aRh9pku+TJjBQ359sorndliANUKKBpH49u49ztz2OtatWdXHw8pVXVGDlN r7yCpH7VuNge3MsKG/Lc6d00uKLGo18Wexvf3cX2PqYN0dXxbD0FpF3BOLK8RrDj4Z A7IysOomqoX2SAvFro1kkhAAf6oNYARwAbLAlHEvi7fgCptZlLj0hP5PF8WtUMGIqf jo7ZdnqBs4dWhh7d/CjBAR0oNEU285VMbhwIenZlNCVMjIcYDafdCEkROAkeni0KIK IH+2JIK3GQ+DAdePqIBU9zCynHMOy2OeEWr43E2YHbLmP22nWIBWrC7Iof2TebyBp4 /8ZZpVm3nszHj51ON+Lz+rTCQh2zpbO4WRnG1HBcyzsCt92Jpcm From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v4 3/4] builtin/stash: provide a way to export stashes to a ref Date: Thu, 7 Apr 2022 21:53:51 +0000 Message-Id: <20220407215352.3491567-4-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220407215352.3491567-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220407215352.3491567-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 | 182 ++++++++++++++++++++++++++++++++++++ 2 files changed, 203 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 b677739bcd..07b0897eda 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; @@ -1775,6 +1782,179 @@ 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) { + ret = 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 = error(_("could not write commit")); + goto out; + } +out: + strbuf_release(&msg); + unuse_commit_buffer(this, buffer); + free(author); + free(committer); + return ret; +} + +static int do_export_stash(const char *ref, int 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], 1) || + get_oid_with_context(the_repository, revision.buf, + GET_OID_QUIETLY | GET_OID_GENTLY, + &items[i], &unused)) { + res = error(_("unable to find stash entry %s"), argv[i]); + 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); + res = write_commit_with_parents(&out, &items[i], parents); + if (res) + 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: + strbuf_release(&revision); + 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) +{ + 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++; + } + + return do_export_stash(ref, argc, argv); +} + int cmd_stash(int argc, const char **argv, const char *prefix) { pid_t pid = getpid(); @@ -1818,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 Thu Apr 7 21:53:52 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: 12805832 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 57363C433F5 for ; Thu, 7 Apr 2022 22:08:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231892AbiDGWKa (ORCPT ); Thu, 7 Apr 2022 18:10:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47980 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231836AbiDGWKY (ORCPT ); Thu, 7 Apr 2022 18:10:24 -0400 Received: from ring.crustytoothpaste.net (ring.crustytoothpaste.net [172.105.110.227]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6CA8017043 for ; Thu, 7 Apr 2022 14:54:00 -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 187D25A3F2; Thu, 7 Apr 2022 21:54:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=crustytoothpaste.net; s=default; t=1649368440; bh=ZE5Ngr7WJKRyFSo4s8EJRh0mifCQiyL6mIKl/5//AZc=; 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=gOni8ARMC6+vOpPrelDdioPZHTVFVYVrNzH+TABMfN2MEKIbCvWNTnjarr4ZwcH/C jDHUSBakw1gDURHG3b/13FqXjeGDB4I5tEt4Rc0znvoVg83EWDlWXRZe4xupnrwfRL 9psDobEvMlXnbCy/kmVwmA4OmdTQoXX3gxlHOJ1V0TZ0yEs4+8E6BZ5vETyWhgKlsK cd5+1GWcG7p2ZW9ptmGLW/fGR4Sf4b1xcPecDEnPmtiALqh7h6qSeAAghTz4QdGsXj 6K2KcCm0+bPAGQQmyQnqavETZMrLLPLLnjJ0GhgM3q027S9nsjDFWGAXcptMYZmPRG jBKFD83zJmaMjR20fDALCm8xZA6uTFbymFKJCYCGk15H0yVyaqsqOFxU+vbVFo/GVs 71Q5QDfGcxdFYtPS9ZK2Q8Q+wGDNBGTD/he/h6FF2tXlsJd/CmSLIOj4rxDxwmVnk0 vr0qTDrLRgfeUXOh5DYJ+Hd45ZvP+ClcYOc8fVhZQYi4u6GVSu7 From: "brian m. carlson" To: Cc: Junio C Hamano , Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= Subject: [PATCH v4 4/4] builtin/stash: provide a way to import stashes from a ref Date: Thu, 7 Apr 2022 21:53:52 +0000 Message-Id: <20220407215352.3491567-5-sandals@crustytoothpaste.net> X-Mailer: git-send-email 2.35.1.473.g83b2b277ed In-Reply-To: <20220407215352.3491567-1-sandals@crustytoothpaste.net> References: <20220310173236.4165310-1-sandals@crustytoothpaste.net> <20220407215352.3491567-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 | 105 ++++++++++++++++++++++++++++++++++++ t/t3903-stash.sh | 63 ++++++++++++++++++++++ 3 files changed, 175 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 07b0897eda..06fa74c0c2 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; @@ -1827,6 +1834,102 @@ 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; + struct oid_array items = OID_ARRAY_INIT; + 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; + oid_array_append(&items, &oid); + } + + /* + * Now, walk each entry, adding it to the stash as a normal stash + * commit. + */ + for (i = items.nr - 1; i >= 0; i--) { + unsigned long bufsize; + const char *p; + const struct object_id *oid = items.oid + i; + + this = lookup_commit_reference(the_repository, oid); + buffer = get_commit_buffer(this, &bufsize); + if (!buffer) { + res = -1; + error(_("cannot read commit buffer for %s"), oid_to_hex(oid)); + goto out; + } + + p = memmem(buffer, bufsize, "\n\n", 2); + if (!p) { + res = -1; + error(_("cannot parse commit %s"), oid_to_hex(oid)); + goto out; + } + + p += 2; + msg = xmemdupz(p, bufsize - (p - buffer)); + unuse_commit_buffer(this, buffer); + buffer = NULL; + + if (do_store_stash(oid, msg, 1)) { + res = -1; + error(_("cannot save the stash for %s"), oid_to_hex(oid)); + goto out; + } + FREE_AND_NULL(msg); + } +out: + if (this && buffer) + unuse_commit_buffer(this, buffer); + oid_array_clear(&items); + free(msg); + + return res; +} + +static int import_stash(int argc, const char **argv, const char *prefix) +{ + struct option options[] = { + OPT_END() + }; + + argc = parse_options(argc, argv, prefix, options, + git_stash_import_usage, + PARSE_OPT_KEEP_DASHDASH); + + if (argc != 1) { + usage_with_options(git_stash_import_usage, options); + return -1; + } + + return do_import_stash(argv[0]); +} + static int do_export_stash(const char *ref, int argc, const char **argv) { struct object_id base; @@ -2000,6 +2103,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..03607a5a38 100755 --- a/t/t3903-stash.sh +++ b/t/t3903-stash.sh @@ -10,6 +10,13 @@ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME . ./test-lib.sh +test_expect_success 'setup' ' + test_oid_cache <<-EOF + export_base sha1:73c9bab443d1f88ac61aa533d2eeaaa15451239c + export_base sha256:f210fa6346e3e2ce047bdb570426b17075980c1ac01fec8fc4b75bd3ab4bcfe4 + EOF +' + test_expect_success 'usage on cmd and subcommand invalid option' ' test_expect_code 129 git stash --invalid-option 2>usage && grep "or: git stash" usage && @@ -1295,6 +1302,62 @@ 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 --include-untracked -- subdir/ && + git tag t-stash0 stash@{0} && + git tag t-stash1 stash@{1} && + simple=$(git stash export --print) && + git stash clear && + git stash import "$simple" && + test_cmp_rev stash@{0} t-stash0 && + test_cmp_rev stash@{1} t-stash1 && + git stash export --to-ref refs/heads/foo && + git stash clear && + git stash import foo && + test_cmp_rev stash@{0} t-stash0 && + test_cmp_rev stash@{1} t-stash1 +' + +test_expect_success 'stash import appends commits' ' + git log --format=oneline -g refs/stash >out && + cat out out >out2 && + git stash import refs/heads/foo && + git log --format=oneline -g refs/stash >actual && + test_line_count = $(wc -l actual && + test_line_count = 2 actual +' + +test_expect_success 'stash can import and export zero stashes' ' + git stash clear && + git stash export --to-ref baz && + test_cmp_rev "$(test_oid empty_tree)" baz: && + test_cmp_rev "$(test_oid export_base)" baz && + test_must_fail git rev-parse baz^1 && + git stash import baz && + test_must_fail git rev-parse refs/stash +' + test_expect_success 'stash apply should succeed with unmodified file' ' echo base >file && git add file &&