From patchwork Tue Jan 25 18:42:11 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derrick Stolee X-Patchwork-Id: 12724143 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 CF02AC433FE for ; Tue, 25 Jan 2022 18:43:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233129AbiAYSmi (ORCPT ); Tue, 25 Jan 2022 13:42:38 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39902 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233090AbiAYSmU (ORCPT ); Tue, 25 Jan 2022 13:42:20 -0500 Received: from mail-wr1-x432.google.com (mail-wr1-x432.google.com [IPv6:2a00:1450:4864:20::432]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DAD69C061744 for ; Tue, 25 Jan 2022 10:42:19 -0800 (PST) Received: by mail-wr1-x432.google.com with SMTP id s18so21563313wrv.7 for ; Tue, 25 Jan 2022 10:42:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=jsxUMLHxtK7S8EQUs8/9O6ekGTMZd12pY38Rj8BEQxg=; b=kH2GRcJXkrtqQFUYxVQ5PAQu0/dQU/lF/vEls7ZNipqab4T/KslB2VmmhMF3dNaA5o Eef9ZGNfSSsRHHWzbAE5nTNkENkmEy3yMXCtwXhTPMwJrEjMOoypW3TNkPaUZ81UAHXs RjPL2ijXeFHiaFXng3gcnpso9pEy+GyWUwsLMLebymq2hA+Mqrt5qOZyar7a+9GuT7Xq yLx5SYvazNGB1N3UYrPquQD60wqwsotmTOKt2GlrCU6+UgdusEqKao/BFh4jZCq8n1ta p2UetpYtXfsjwrgGWLC/tEE8fxFoukwSWO2uwNpuOCvXb+LC3vJI1eEle47V3aJ4Ktom QC1A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=jsxUMLHxtK7S8EQUs8/9O6ekGTMZd12pY38Rj8BEQxg=; b=Soiis4j7vi6Y7HjItEA8cEDDVJjHYgPtZwzUV1y/khX2uqmjjOndcjGOP26+gbcB5t irAbg8j7Tj4ypu2ysirJcSZBFy+occ6jQux0yJje5VuAV/ZVdRk/Gcv1qxP1NY+39v4a dkPKwbYPVcs8lEkXi8qlAFMXlI2MLM1DGF5w0OJc8uNfMIqkm8FhKN9bsT9amLLYsjuW y8gS3ceg9xs185l7E8r+V+BL02LA5XP7EeoBrq5AWJFpGTFEtJIJOdkNbYcvjYrSmO5R AjjFnGpayogq7GsrpiNHstGZEQv5Jp1L2xptXDC6G+Wx8NaMuxHlOOgdLc1uwgoh3uFv NiIA== X-Gm-Message-State: AOAM532LT7HBSMzdznFwQsB1Znby5+Wng2GpZlcnep+P7misCnbXstE2 czUPQOy3ivBzFEPeNNA0nBFkNYDGhkrJkQ== X-Google-Smtp-Source: ABdhPJzV9BzJ3LeqmL86VZcgiP99STnYQ8Z1mpt3SlD4uWjPrp3FTwqPsXjSdpzDuQVQ1UYUQtFrTA== X-Received: by 2002:adf:f850:: with SMTP id d16mr19924403wrq.303.1643136138144; Tue, 25 Jan 2022 10:42:18 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id c10sm17456326wrq.11.2022.01.25.10.42.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Jan 2022 10:42:17 -0800 (PST) Message-Id: In-Reply-To: References: Date: Tue, 25 Jan 2022 18:42:11 +0000 Subject: [PATCH v4 2/5] worktree: create init_worktree_config() Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: stolee@gmail.com, sunshine@sunshineco.com, allred.sean@gmail.com, gitster@pobox.com, Elijah Newren , Derrick Stolee , Derrick Stolee Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Derrick Stolee From: Derrick Stolee Upgrading a repository to use extensions.worktreeConfig is non-trivial. There are several steps involved, including moving some config settings from the common config file to the main worktree's config.worktree file. The previous change updated the documentation with all of these details. Commands such as 'git sparse-checkout set' upgrade the repository to use extensions.worktreeConfig without following these steps, causing some user pain in some special cases. Create a helper method, init_worktree_config(), that will be used in a later change to fix this behavior within 'git sparse-checkout set'. The method is carefully documented in worktree.h. Note that we do _not_ upgrade the repository format version to 1 during this process. The worktree config extension must be considered by Git and third-party tools even if core.repositoryFormatVersion is 0 for historical reasons documented in 11664196ac ("Revert "check_repository_format_gently(): refuse extensions for old repositories"", 2020-07-15). This is a special case for this extension, and newer extensions (such as extensions.objectFormat) still need to upgrade the repository format version. Signed-off-by: Derrick Stolee --- worktree.c | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ worktree.h | 19 +++++++++++++++ 2 files changed, 89 insertions(+) diff --git a/worktree.c b/worktree.c index 6f598dcfcdf..dc4ead4c8fb 100644 --- a/worktree.c +++ b/worktree.c @@ -5,6 +5,7 @@ #include "worktree.h" #include "dir.h" #include "wt-status.h" +#include "config.h" void free_worktrees(struct worktree **worktrees) { @@ -826,3 +827,72 @@ int should_prune_worktree(const char *id, struct strbuf *reason, char **wtpath, *wtpath = path; return 0; } + +static int move_config_setting(const char *key, const char *value, + const char *from_file, const char *to_file) +{ + if (git_config_set_in_file_gently(to_file, key, value)) + return error(_("unable to set %s in '%s'"), key, to_file); + if (git_config_set_in_file_gently(from_file, key, NULL)) + return error(_("unable to unset %s in '%s'"), key, from_file); + return 0; +} + +int init_worktree_config(struct repository *r) +{ + int res = 0; + int bare = 0; + struct config_set cs = { { 0 } }; + const char *core_worktree; + char *common_config_file = xstrfmt("%s/config", r->commondir); + char *main_worktree_file = xstrfmt("%s/config.worktree", r->commondir); + + /* + * If the extension is already enabled, then we can skip the + * upgrade process. + */ + if (repository_format_worktree_config) + return 0; + if ((res = git_config_set_gently("extensions.worktreeConfig", "true"))) + return error(_("failed to set extensions.worktreeConfig setting")); + + git_configset_init(&cs); + git_configset_add_file(&cs, common_config_file); + + /* + * If core.bare is true in the common config file, then we need to + * move it to the base worktree's config file or it will break all + * worktrees. If it is false, then leave it in place because it + * _could_ be negating a global core.bare=true. + */ + if (!git_configset_get_bool(&cs, "core.bare", &bare) && bare) { + if ((res = move_config_setting("core.bare", "true", + common_config_file, + main_worktree_file))) + goto cleanup; + } + /* + * If core.worktree is set, then the base worktree is located + * somewhere different than the parent of the common Git dir. + * Relocate that value to avoid breaking all worktrees with this + * upgrade to worktree config. + */ + if (!git_configset_get_string_tmp(&cs, "core.worktree", &core_worktree)) { + if ((res = move_config_setting("core.worktree", core_worktree, + common_config_file, + main_worktree_file))) + goto cleanup; + } + + /* + * Ensure that we use worktree config for the remaining lifetime + * of the current process. + */ + repository_format_worktree_config = 1; + +cleanup: + git_configset_clear(&cs); + free(common_config_file); + free(main_worktree_file); + return res; +} diff --git a/worktree.h b/worktree.h index 9e06fcbdf3d..5ea5fcc3647 100644 --- a/worktree.h +++ b/worktree.h @@ -183,4 +183,23 @@ void strbuf_worktree_ref(const struct worktree *wt, struct strbuf *sb, const char *refname); +/** + * Enable worktree config for the first time. This will make the following + * adjustments: + * + * 1. Add extensions.worktreeConfig=true in the common config file. + * + * 2. If the common config file has a core.worktree value or core.bare is + * set to true, then those values are moved to the main worktree's + * config.worktree file. + * + * If extensions.worktreeConfig is already true, then this method + * terminates early without any of the above steps. The existing config + * arrangement is assumed to be intentional. + * + * Returns 0 on success. Reports an error message and returns non-zero + * if any of these steps fail. + */ +int init_worktree_config(struct repository *r); + #endif