From patchwork Tue Jun 4 12:32:36 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Patrick Steinhardt X-Patchwork-Id: 13685162 Received: from fout1-smtp.messagingengine.com (fout1-smtp.messagingengine.com [103.168.172.144]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A72EA14600F for ; Tue, 4 Jun 2024 12:32:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=103.168.172.144 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504364; cv=none; b=p9BhREuhtz6tpaPKuckdYlAUOxnUe9nqZeH+q0n/0lGJH22uXMIBAmRwEupfXSAmG0d/kHaL+11KpW29DiaQ+kRyx9QD51P0oAYg27PTvUWhsCBh8XmmzTOMvobx41c6VdCLKYVDL1uvjIuxt/r3b2/0k2dfueM6Un086oelVyA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504364; c=relaxed/simple; bh=jVaYcMs9u5o6ZhAebx0/FEFS71PCkHGQlti8sUBECFI=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=FGzUYLxivaoN/pT7dt+tK8nogAUpfegVRsLn31MA+3Qr39KG23Sdjf/Q/GGkfb9IyiE3kmaoKdTEoONW0hU+TRPOpstPA/NKioq3ob7WqK6lPTJFz0YTacUWAQZrOWJPPGa0ru0SzVvUpPxNGxyi5/4OTtup2BprXafDZZk0fRo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im; spf=pass smtp.mailfrom=pks.im; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b=Ov0y8fBp; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b=Rse8s+YE; arc=none smtp.client-ip=103.168.172.144 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pks.im Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b="Ov0y8fBp"; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b="Rse8s+YE" Received: from compute7.internal (compute7.nyi.internal [10.202.2.48]) by mailfout.nyi.internal (Postfix) with ESMTP id B071A138013D; Tue, 4 Jun 2024 08:32:40 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute7.internal (MEProxy); Tue, 04 Jun 2024 08:32:40 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pks.im; h=cc:cc :content-type:content-type:date:date:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:subject :subject:to:to; s=fm1; t=1717504360; x=1717590760; bh=QPtCs0rtG0 OsIQWeQPWIxDMgt6UbCPO5UdtGRpGKM6Y=; b=Ov0y8fBp9c/5A90U0c1C7/C1Jz G5xZ5oi0u6VNqYQwbUulcER8VyqzPXQbdIAApaIIi2wV97X7S5TGmumOcXeImM2R isrD3NuYPXMN53LDi8V96b0N0I5Jjg0YfODKUfRPDnyVlja1oCySbWln+YwAlSs4 OcI6mXj/TIIZAGyVqVoKX2VxWiQCg1Qe+1XvnoqTXS8TcbGq8qrdjHPuQWu4gV6W dbz8yZOz4Ids1kOXEMmx1O5yj9LFEt3xyA4voFFTOCQ9U+fhZyBNdddazuwuKOGe kD21Jl5GqNRQwPIKtul8H4Tp3s8UCdGVX5PNNnzzBfW5+nwz86UZ9lmo0DHQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; t=1717504360; x=1717590760; bh=QPtCs0rtG0OsIQWeQPWIxDMgt6Ub CPO5UdtGRpGKM6Y=; b=Rse8s+YEXapFoBisydwatOedRfltEn/qcoxtgUk3TZVW Ysc+6G0fte5N8bjCE4hzgi5KqG6GBFCdNk3SkMyjJIeyanyCsSZ6BlL9DMFuCqLM QWz+/zj97uRvyXQ4+2vTdbxyJEu0Y+Tu6bO745FRezlBIWf2eHexrycosZKb+piQ cICcdK0DPGBzYKGp91/EeFhZnAuE0MX3rf3KPU6cCCFiuOVfbyB2BQ9mQ70zzuQk UZxbC1jrGKy1tltCRpxJHgdv4978ERP2B8MB9DDdiPzcYZlRi+lZY7ceMIVBnITB VTTOxRic2kIeXe5sTm5G14MQdm7XPITFiTec4zyflg== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrvdelgedggeelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfffhvfevuffkfhggtggujgesghdtreertddtvdenucfhrhhomheprfgrthhr ihgtkhcuufhtvghinhhhrghrughtuceophhssehpkhhsrdhimheqnecuggftrfgrthhtvg hrnhepieevkedtgffgleeugfdvledvfedthfegueegfeevjeelueefkeegfeffhefglefg necuffhomhgrihhnpehkvghrnhgvlhdrohhrghenucevlhhushhtvghrufhiiigvpedtne curfgrrhgrmhepmhgrihhlfhhrohhmpehpshesphhkshdrihhm X-ME-Proxy: Feedback-ID: i197146af:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 4 Jun 2024 08:32:38 -0400 (EDT) Received: by localhost (OpenSMTPD) with ESMTPSA id f2d95823 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Tue, 4 Jun 2024 12:32:12 +0000 (UTC) Date: Tue, 4 Jun 2024 14:32:36 +0200 From: Patrick Steinhardt To: git@vger.kernel.org Cc: Johannes Schindelin , Phillip Wood , Justin Tobler , Junio C Hamano , Dragan Simic , Karthik Nayak , Todd Zullinger Subject: [PATCH v6 1/4] docs: introduce document to announce breaking changes Message-ID: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: Over time, Git has grown quite a lot. With this evolution, many ideas that were sensible at the time they were introduced are not anymore and are thus considered to be deprecated. And while some deprecations may be noted in manpages, most of them are actually deprecated in the "hive mind" of the Git community, only. Introduce a new document that tracks such breaking changes, but also deprecations which we are not willing to go through with, to address this issue. This document serves multiple purposes: - It is a way to facilitate discussion around proposed deprecations. - It allows users to learn about deprecations and speak up in case they have good reasons why a certain feature should not be deprecated. - It states intent and documents where the Git project wants to go, both in the case where we want to deprecate, but also in the case where we don't want to deprecate a specific feature. The document is _not_ intended to cast every single discussion into stone. It is supposed to be a living document that may change over time when there are good reasons for it to change. Signed-off-by: Patrick Steinhardt --- Documentation/BreakingChanges.txt | 74 +++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 Documentation/BreakingChanges.txt diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt new file mode 100644 index 0000000000..36327b13b8 --- /dev/null +++ b/Documentation/BreakingChanges.txt @@ -0,0 +1,74 @@ += Upcoming breaking changes + +The Git project aims to ensure backwards compatibility to the best extent +possible. Minor releases will not break backwards compatibility unless there is +a very strong reason to do so, like for example a security vulnerability. + +Regardless of that, due to the age of the Git project, it is only natural to +accumulate a backlog of backwards-incompatible changes that will eventually be +required to keep the project aligned with a changing world. These changes fall +into several categories: + +* Changes to long established defaults. +* Concepts that have been replaced with a superior design. +* Concepts, commands, configuration or options that have been lacking in major + ways and that cannot be fixed and which will thus be removed without any + replacement. + +Explicitly not included in this list are fixes to minor bugs that may cause a +change in user-visible behavior. + +The Git project irregularly releases breaking versions that deliberately break +backwards compatibility with older versions. This is done to ensure that Git +remains relevant, safe and maintainable going forward. The release cadence of +breaking versions is typically measured in multiple years. The last breaking +releases were: + +* Git 1.6, released in August 2008. In retrospect, this release should likely + have bumped the major version. +* Git 2.0, released in May 2014. + +The intent of this document is to track upcoming deprecations for future +breaking releases. Furthermore, this document also tracks what will _not_ be +deprecated. This is done such that the outcome of discussions document both +when the discussion favors deprecation, but also when it rejects a deprecation. + +Items should have a clear summary of the reasons why we do or do not want to +make the described change that can be easily understood without having to read +the mailing list discussions. If there are alternatives to the changed feature, +those alternatives should be pointed out to our users. + +All items should be accompanied by references to relevant mailing list threads +where the deprecation was discussed. These references use message-IDs, which +can visited via + + https://lore.kernel.org/git/$message_id/ + +to see the message and its surrounding discussion. Such a reference is there to +make it easier for you to find how the project reached concensus on the +described item back then. + +This is a living document as the environment surrounding the project changes +over time. If circumstances change, an earlier decision to deprecate or change +something may need to be revisited from time to time. So do not take items on +this list to mean "it is settled, do not waste our time bringing it up again". + +== Git 3.0 + +The following subsections document upcoming breaking changes for Git 3.0. There +is no planned release date for this breaking version yet. + +Proposed changes and removals only include items which are "ready" to be done. +In other words, this is not supposed to be a wishlist of features that should +be changed to or replaced in case the alternative was implemented already. + +=== Changes + +=== Removals + +== Superseded features that will not be deprecated + +Some features have gained newer replacements that aim to improve the design in +certain ways. The fact that there is a replacement does not automatically mean +that the old way of doing things will eventually be removed. This section tracks +those features with newer alternatives. From patchwork Tue Jun 4 12:32:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Patrick Steinhardt X-Patchwork-Id: 13685163 Received: from fhigh7-smtp.messagingengine.com (fhigh7-smtp.messagingengine.com [103.168.172.158]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 85286146A6D for ; Tue, 4 Jun 2024 12:32:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=103.168.172.158 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504368; cv=none; b=t/IslT4XWg52tLMVIMl/TqnaLWhh4jwlGVRr2XFgutGen5JRvTY/pOLusUMhxTyg8EgvImRQwqdICi8IUZiRPPJjMWqLYeiDKldqk7jMJQyl/IcEbRMUHj8a1QdsjnOndSYxv4IOCpDeo/kMvpgtGaJBFLQcVGy+mlpMebiV5cE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504368; c=relaxed/simple; bh=1/V2RTBJfTTc7fsba8euc1KWsYM4aYxLdRNpqdmH6+s=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=Va7hIjMJVHH0piXPLnWOeTo3or9CU+jnhj3gpNr6AphCuSscPh8/rYhUK8bvWBK2njGtNaMiYMLCOjo+cYb1jxtt3zaLwm92D0Ls+JsEVWxqf0CvCwnsnKzccyD/5pCqaj0sYY0OxjSh+ZYPEcQgZX7JN1WYztJVM8iSvToHRd4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im; spf=pass smtp.mailfrom=pks.im; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b=E64jCCce; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b=Nwlz81F4; arc=none smtp.client-ip=103.168.172.158 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pks.im Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b="E64jCCce"; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b="Nwlz81F4" Received: from compute6.internal (compute6.nyi.internal [10.202.2.47]) by mailfhigh.nyi.internal (Postfix) with ESMTP id A531C114010D; Tue, 4 Jun 2024 08:32:45 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute6.internal (MEProxy); Tue, 04 Jun 2024 08:32:45 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pks.im; h=cc:cc :content-type:content-type:date:date:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:subject :subject:to:to; s=fm1; t=1717504365; x=1717590765; bh=eXWENe1ih3 3E1cgthZURE6UrEzmR5927U+DnD6rxTMw=; b=E64jCCcemGvM7jhUle7Fi1Uk5L oIOohuKOLZMLP9QEhzqWIJkW6alWzYIDCZHkVPldP2Yr2zj1+ReWTtL7WJUp3O1W GWHvLBLwKUT0DbuGDBaWUlj8YJ6Ct/xQDm6IvPWjzL1THyb8QVOuLqN9QbXmj3QL I/h0T27Iiox3Qz9snNHhaTjHvCqMGSkbnbCYFgf5UScO25Mdx2LGhEXUBnpVjtlb 0TGC46VaMxI8tV6oNBMWVKw7fg2YzW46sKEpwitAxaaacxFwswVEZN7WyQXCWBjF xud0EpikK2DjAK5xv9gp+grnzOhe8JIwx+zA+FY8+Yf86fW0rNvsbDKvxKHA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; t=1717504365; x=1717590765; bh=eXWENe1ih33E1cgthZURE6UrEzmR 5927U+DnD6rxTMw=; b=Nwlz81F4VWrRe5MfhE64axpuBv2LEP74F2RrF2MEzJKM qffTR9lBTauo3ntctiZbZY09ChcbGjuP1/Y46d+HJHdX2Jmrdd+4VJsez2pkl+HX MQOd2ZyswPkIwIC8Lva6kimm570UfIWlVllGlrm697NloxiFDsG+ZYL9BctMI0jc 7+USPy6BoRGAUFdNlwKLSWA7F4QpSdoZ95yHK7mortML6r+3U/KqZKjKKBeIRDlk iscFvT5FlujKfhpPY1pDNpHGql9Rt3+fKP39QOAsqVroicdCaLmfRHto6QnJxRIe WjQLe5rbTVHeqbgxiV5sDyWupAmcgczINlgQJV3OKQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrvdelgedggeelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfffhvfevuffkfhggtggujgesghdtreertddtvdenucfhrhhomheprfgrthhr ihgtkhcuufhtvghinhhhrghrughtuceophhssehpkhhsrdhimheqnecuggftrfgrthhtvg hrnhepueektdevtdffveeljeetgfehheeigeekleduvdeffeeghefgledttdehjeelffet necuvehluhhsthgvrhfuihiivgepudenucfrrghrrghmpehmrghilhhfrhhomhepphhsse hpkhhsrdhimh X-ME-Proxy: Feedback-ID: i197146af:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 4 Jun 2024 08:32:43 -0400 (EDT) Received: by localhost (OpenSMTPD) with ESMTPSA id 99b0a7a2 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Tue, 4 Jun 2024 12:32:17 +0000 (UTC) Date: Tue, 4 Jun 2024 14:32:41 +0200 From: Patrick Steinhardt To: git@vger.kernel.org Cc: Johannes Schindelin , Phillip Wood , Justin Tobler , Junio C Hamano , Dragan Simic , Karthik Nayak , Todd Zullinger Subject: [PATCH v6 2/4] BreakingChanges: document upcoming change from "sha1" to "sha256" Message-ID: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: Starting with 8e42eb0e9a (doc: sha256 is no longer experimental, 2023-07-31), the "sha256" object format is no longer considered to be experimental. Furthermore, the SHA-1 hash function is actively recommended against by for example NIST and FIPS 140-2, and attacks against it are becoming more practical both due to new weaknesses (SHAppening, SHAttered, Shambles) and due to the ever-increasing computing power. It is only a matter of time before it can be considered to be broken completely. Let's plan for this event by being active instead of waiting for it to happend and announce that the default object format is going to change from "sha1" to "sha256" with Git 3.0. All major Git implementations (libgit2, JGit, go-git) support the "sha256" object format and are thus prepared for this change. The most important missing piece in the puzzle is support in forges. But while GitLab recently gained experimental support for the "sha256" object format though, to the best of my knowledge GitHub doesn't support it yet. Ideally, announcing this upcoming change will encourage forges to start building that support. Signed-off-by: Patrick Steinhardt --- Documentation/BreakingChanges.txt | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt index 36327b13b8..5d7e80aebb 100644 --- a/Documentation/BreakingChanges.txt +++ b/Documentation/BreakingChanges.txt @@ -64,6 +64,36 @@ be changed to or replaced in case the alternative was implemented already. === Changes +* The default hash function for new repositories will be changed from "sha1" + to "sha256". SHA-1 has been deprecated by NIST in 2011 and is nowadays + recommended against in FIPS 140-2 and similar certifications. Furthermore, + there are practical attacks on SHA-1 that weaken its cryptographic properties: ++ + ** The SHAppening (2015). The first demonstration of a practical attack + against SHA-1 with 2^57 operations. + ** SHAttered (2017). Generation of two valid PDF files with 2^63 operations. + ** Birthday-Near-Collision (2019). This attack allows for chosen prefix + attacks with 2^68 operations. + ** Shambles (2020). This attack allows for chosen prefix attacks with 2^63 + operations. ++ +While we have protections in place against known attacks, it is expected +that more attacks against SHA-1 will be found by future research. Paired +with the ever-growing capability of hardware, it is only a matter of time +before SHA-1 will be considered broken completely. We want to be prepared +and will thus change the default hash algorithm to "sha256" for newly +initialized repositories. ++ +An important requirement for this change is that the ecosystem is ready to +support the "sha256" object format. This includes popular Git libraries, +applications and forges. ++ +There is no plan to deprecate the "sha1" object format at this point in time. ++ +Cf. <2f5de416-04ba-c23d-1e0b-83bb655829a7@zombino.com>, +<20170223155046.e7nxivfwqqoprsqj@LykOS.localdomain>, +. + === Removals == Superseded features that will not be deprecated From patchwork Tue Jun 4 12:32:46 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Patrick Steinhardt X-Patchwork-Id: 13685164 Received: from fhigh7-smtp.messagingengine.com (fhigh7-smtp.messagingengine.com [103.168.172.158]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 671A5146586 for ; Tue, 4 Jun 2024 12:32:51 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=103.168.172.158 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504373; cv=none; b=st41s76/5P3hybpON2bU7nHP7HHsIyCMHUN1LhacmRBZvNbffsQqOyGysn0uNny4vsM39cRQVIXYP7OMEJ0qzr1eROzWsScPokUkb/OdY9dVjMyZWdjerbLsptvhrpoSqad5HS2ecaW6TtBRllB+JS2TCzlwHBy6YyghYAsUzkY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504373; c=relaxed/simple; bh=1fwHZdwwJ8LOkyd3c4rg20lSH7jVfdr8AcUHuhBnw9w=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=uPoXd47OplacgPWuqvi7jrzGcN/ZIp5hRW/lkIwbLhY5Obo7I2I5lM0FO91s4/KwR8rHApounZA18A4y1k8J5zhbLcyXVIha5Nsh87//a9SdOq2vZ5nQuIgOx0zMwtWCikPFae9aiE/tDeMQoxPf5qLxS2L13NEFyEQZ/jua4O0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im; spf=pass smtp.mailfrom=pks.im; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b=P65PTmOt; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b=AeZ7HDDh; arc=none smtp.client-ip=103.168.172.158 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pks.im Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b="P65PTmOt"; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b="AeZ7HDDh" Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 8A6061140165; Tue, 4 Jun 2024 08:32:50 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Tue, 04 Jun 2024 08:32:50 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pks.im; h=cc:cc :content-type:content-type:date:date:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:subject :subject:to:to; s=fm1; t=1717504370; x=1717590770; bh=hGrYK65w7A 2Fha4oNtbMQLRjwBGPH3fKhymMW702FYw=; b=P65PTmOtRn7502SeNtSjPIpftv o4rR6TuQbtOfhld157w/xqy3kkSYihFNchVCzpnD0k45ows+PzMMv8zoNEY03TOe Q9rJgdJjLXnxjLQDHciqpmqbCZoPj1NbmojTowLmYHxvewdoU/6Dsm4tGwNvAHCD XxAW9frj5NBXMOMsyqe3fCCeAmil2o1wbvcK4jy1oEOMfOATy7F21ZqtjDILdRhk FoATOHcUbbEJUxMBrGozRrKxefgHpayPkg6W5AXNx1O4sY36+8Ek6eRImwL5/kob eQj7TfLVGYJTLEkPb3dzMS3UM/zzErJp/pPg4evoDtRvV+w+mwQLsCq0hMQA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; t=1717504370; x=1717590770; bh=hGrYK65w7A2Fha4oNtbMQLRjwBGP H3fKhymMW702FYw=; b=AeZ7HDDhKuRcmfDbj5abKpG+RL3x3AcA2zXqgKXlOubR sJ+akXObBlECiZAqZrDgucpn7xLio0QdE0cSOLgeYOKrTyO3UPXJGV4T8VtywXzN aH8YldG4M/CGj2GBAe55m4maOMLgczsLB+TM4ADX/pkXZiUlh7DI3h7R0/ONpnah ZGMjiXuikQdfEQKbuRxVR4RdR8WZq/nH73wjEFuDzxK7tJJ+k1K/SarAxHmOiEge pI6ojtH+3q+ZQIZ1yH26mZYmkBWNlcoDaXnhscqEOheXq/D/EeO3dixDnZn97wlv D96qWrAb0okRgrW9ln2aOWs7jFAF3fU2j1Xea+aArw== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrvdelgedggeelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfffhvfevuffkfhggtggujgesghdtreertddtvdenucfhrhhomheprfgrthhr ihgtkhcuufhtvghinhhhrghrughtuceophhssehpkhhsrdhimheqnecuggftrfgrthhtvg hrnhepueektdevtdffveeljeetgfehheeigeekleduvdeffeeghefgledttdehjeelffet necuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepphhsse hpkhhsrdhimh X-ME-Proxy: Feedback-ID: i197146af:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 4 Jun 2024 08:32:48 -0400 (EDT) Received: by localhost (OpenSMTPD) with ESMTPSA id 1b0b4e02 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Tue, 4 Jun 2024 12:32:21 +0000 (UTC) Date: Tue, 4 Jun 2024 14:32:46 +0200 From: Patrick Steinhardt To: git@vger.kernel.org Cc: Johannes Schindelin , Phillip Wood , Justin Tobler , Junio C Hamano , Dragan Simic , Karthik Nayak , Todd Zullinger Subject: [PATCH v6 3/4] BreakingChanges: document removal of grafting Message-ID: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: The grafting mechanism for objects has been deprecated in e650d0643b (docs: mark info/grafts as outdated, 2014-03-05), which is more than a decade ago. The mechanism can lead to hard-to-debug issues and has a superior replacement with replace refs. Follow through with the deprecation and mark grafts for removal in Git 3.0. Signed-off-by: Patrick Steinhardt --- Documentation/BreakingChanges.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt index 5d7e80aebb..9fb6d8c78a 100644 --- a/Documentation/BreakingChanges.txt +++ b/Documentation/BreakingChanges.txt @@ -96,6 +96,18 @@ Cf. <2f5de416-04ba-c23d-1e0b-83bb655829a7@zombino.com>, === Removals +* Support for grafting commits has long been superseded by git-replace(1). + Grafts are inferior to replacement refs: ++ + ** Grafts are a local-only mechanism and cannot be shared across reositories. + ** Grafts can lead to hard-to-diagnose problems when transferring objects + between repositories. ++ +The grafting mechanism has been marked as outdated since e650d0643b (docs: mark +info/grafts as outdated, 2014-03-05) and will be removed. ++ +Cf. <20140304174806.GA11561@sigill.intra.peff.net>. + == Superseded features that will not be deprecated Some features have gained newer replacements that aim to improve the design in From patchwork Tue Jun 4 12:32:51 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Patrick Steinhardt X-Patchwork-Id: 13685165 Received: from fhigh7-smtp.messagingengine.com (fhigh7-smtp.messagingengine.com [103.168.172.158]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5BAE2147C9E for ; Tue, 4 Jun 2024 12:32:56 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=103.168.172.158 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504378; cv=none; b=n6xShtFO67wp5FF7nyRo4cxVErll7Kwsw8M4kkycYRVMQbWVL/SXhsNEZ0myfnd7NWYxpCpScYIcOg7XqgEJtCYctQUEnizYcjhyb6abL1YC1HTor91Gnpr5K9oUSZwLsv1ly1z13jgcFMcZt3CaWXSMEBpK0hc9y2LU02CyLuQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1717504378; c=relaxed/simple; bh=4992lzSV0IStGfrvlq/nrm3SQJkcFBF+MTcE52Fujz0=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=esOC4DnGpKQwEqNSYtcLwXHEkLzOdNlZQbBhlxMtYhmfaN5nuCld3HvrXjKksg8eIkHDK5A80TQocPeB5XkJqjOKy65uJ/MZL8Is9nJqzR/oQdPrZ13QQr27gFfrIFHq1MftHZDahRZ1pGM2rkM9SCHUEZYEeC/6u380HT6Glqk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im; spf=pass smtp.mailfrom=pks.im; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b=WWRrVxu9; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b=C8XRaaTo; arc=none smtp.client-ip=103.168.172.158 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pks.im Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b="WWRrVxu9"; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b="C8XRaaTo" Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 71843114010D; Tue, 4 Jun 2024 08:32:55 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Tue, 04 Jun 2024 08:32:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pks.im; h=cc:cc :content-type:content-type:date:date:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:subject :subject:to:to; s=fm1; t=1717504375; x=1717590775; bh=7PTPOcI2I1 21Dpv5eEyKO4niO2MNQLeVdacb/z2x6NQ=; b=WWRrVxu9pmKXu5cJgTnlpe0rBx RcIgtKcWr3ssOjcf1iffBpjqVtVQ7wXf8v4yr5qfwAzrtecKBGe5xjK6EdW+Whm0 e+8SJS0v1LwhreEp9p4SdKz71Hn8esbSEmQd0gjynf72Dkqlu6aABRlWbCbaQBR1 muEBpoPfuM2hgFoWXCOYOGqerXWWZUsAts0Kze6nbI5buDsYAu5aT7B0AF706r8a chAAy42kPEgem3y/fa1ivUolHVYqiEZzWVxaxQB0A+GzXG6XmBR3QPnIAIfAk4mD DZo669vd0jkzXi6KF0NvG9gZaU5PWRNn9g54OTZWrW44nWhLDX5lCS75XnoA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; t=1717504375; x=1717590775; bh=7PTPOcI2I121Dpv5eEyKO4niO2MN QLeVdacb/z2x6NQ=; b=C8XRaaToEhmcAI/kkta1ZDY74gGqJG5TrQBKmlKRNyEg EoL+D6DBUvuhCizKRp0G/QAyszoohEafpggqR5j9NuhvXFokrmp2DoVqWLgWFUSW OHoDuTgQTX/YqWb9HFMFTnoCSYlcUnlbHINJH7kQDnM9CJonSgvqs23AhYBJND1C QjH2RDULUjz/FDaHEAsDoqeJ0lXEG1BD3UICGErhvF7pyyw0vrnVwR1f8XTFOllG 9VQLvTU9svl7CG4o9JuWcE5enFB2De9hqzFy/NW3uxEAv80apTa+07VJ+fyxhZzk El83tQNt3EOrMgF0ylGUiaLFfj/4VsVcIoACzHui4A== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrvdelgedggeelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfffhvfevuffkfhggtggujgesghdtreertddtvdenucfhrhhomheprfgrthhr ihgtkhcuufhtvghinhhhrghrughtuceophhssehpkhhsrdhimheqnecuggftrfgrthhtvg hrnhepueektdevtdffveeljeetgfehheeigeekleduvdeffeeghefgledttdehjeelffet necuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepphhsse hpkhhsrdhimh X-ME-Proxy: Feedback-ID: i197146af:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 4 Jun 2024 08:32:53 -0400 (EDT) Received: by localhost (OpenSMTPD) with ESMTPSA id 334ce305 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Tue, 4 Jun 2024 12:32:26 +0000 (UTC) Date: Tue, 4 Jun 2024 14:32:51 +0200 From: Patrick Steinhardt To: git@vger.kernel.org Cc: Johannes Schindelin , Phillip Wood , Justin Tobler , Junio C Hamano , Dragan Simic , Karthik Nayak , Todd Zullinger Subject: [PATCH v6 4/4] BreakingChanges: document that we do not plan to deprecate git-checkout Message-ID: <4fafccc3b919d68c51f83b2cb0c04f8621c17426.1717504292.git.ps@pks.im> References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: The git-checkout(1) command is seen by many as hard to understand because it connects two somewhat unrelated features: switching between branches and restoring worktree files from arbitrary revisions. In 2019, we thus implemented two new commands git-switch(1) and git-restore(1) to split out these separate concerns into standalone functions. This "replacement" of git-checkout(1) has repeatedly triggered concerns for our userbase that git-checkout(1) will eventually go away. This is not the case though: the use of that command is still widespread, and it is not expected that this will change anytime soon. Document that all three commands will remain for the foreseeable future. This decision may be revisited in case we ever figure out that most everyone has given up on any of the commands. Signed-off-by: Patrick Steinhardt --- Documentation/BreakingChanges.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.txt index 9fb6d8c78a..0fd60a7776 100644 --- a/Documentation/BreakingChanges.txt +++ b/Documentation/BreakingChanges.txt @@ -114,3 +114,15 @@ Some features have gained newer replacements that aim to improve the design in certain ways. The fact that there is a replacement does not automatically mean that the old way of doing things will eventually be removed. This section tracks those features with newer alternatives. + +* The features git-checkout(1) offers are covered by the pair of commands + git-restore(1) and git-switch(1). Because the use of git-checkout(1) is still + widespread, and it is not expected that this will change anytime soon, all + three commands will stay. ++ +This decision may get revisited in case we ever figure out that there are +almost no users of any of the commands anymore. ++ +Cf. , +, +<112b6568912a6de6672bf5592c3a718e@manjaro.org>.