From patchwork Fri Jun 14 06:42:30 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Patrick Steinhardt X-Patchwork-Id: 13697918 Received: from fhigh8-smtp.messagingengine.com (fhigh8-smtp.messagingengine.com [103.168.172.159]) (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 10832145B34 for ; Fri, 14 Jun 2024 06:42:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=103.168.172.159 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718347359; cv=none; b=WKLpvrGytP9KogQ5aCaM1OlqiPUwymlGD/ozxHBqSAvu8zx23Qu96nHAwfCsEqeSiTmGlKNOeqEpGu4yle33XAcVuEeCeFFNgNxF5opRYe6Ydj4vL2FJ6YMDCJ6CsVKfYqRNsrpKDpm3Ug2lnCOm1tH7dr+uoowDL3hvHE8ySUo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718347359; c=relaxed/simple; bh=qt/aFgrHDJwsyjrLPzXJO1x5NnVCWx1dQbwOWMH5Jwg=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=tww/JIwBO213gE18UnSKd9hh3JpqEfhBQgzR6p3rIoPOMPExXhbJfi4DSNyOXGxfCG0aovPhpBFqiuW5/RmDmwbPUoDo7KeLtBPVkKScdVD2ThMw3W6eNlG6VsvJFc/7/2VyWlLCMdNYBUxBqvIfRzCYf4fmJgQSWeyX6eL+SGU= 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=MVwjzQgT; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b=c7k5WPes; arc=none smtp.client-ip=103.168.172.159 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="MVwjzQgT"; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b="c7k5WPes" Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 0567911401C5; Fri, 14 Jun 2024 02:42:37 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Fri, 14 Jun 2024 02:42:37 -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=1718347357; x=1718433757; bh=6CaQYsKSPT DPvIFOfDyg4pduqC4EYTNMWjvQ3d0N9LU=; b=MVwjzQgTmD91e2h3PvMzNIanbC gVUOcOePKK5J/i89Jf5CnSZT9nEZNKzujWF4yfFaMorvNA7NQcPx949wPTuNrgOs 96xz0psTIqz6dzZcw6vgUMZdkrwnVaOIBC85l8JJOVHvi07oNQkWJa2iXR6X8Ocu mvEzWUXSssatU0mkbw++j1JkxtrRWj7QpqwE9ko08vWJSxkXEYZuSzh51zuOQTRf Mt96Uc4dk58lHl6uX16k2LKKkKwYAjISa0lglS9AyJGZAyCPRwPKrVnT696H/L3m iaGFrhZU8OVGrC3o5uhfGyRBE+QG39uAytWibTTyKZTxxUtKtIiyqCCk/xVg== 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=1718347357; x=1718433757; bh=6CaQYsKSPTDPvIFOfDyg4pduqC4E YTNMWjvQ3d0N9LU=; b=c7k5WPesVXwTGaMrspSooBVKfRXe13gi4rmHeLneEPzm 9wXqMP4wpSCmqgt3zmQQ2vjqHzMdjwa6Vgf7/SuFELpAbQwTnG4Ap/k6/ApqRDNv 0FS2cXrwvgkkPcpw8mHTZih9i0zmf07HMcpsKmUNL0t+jvhkaE8V7AXvvlXihWFH 1MGyot1wlhGF+c6jl4eNj8ToU7BkOfRu3ZaysI9GcDPD2dJc66sRcyuiubLKPuzt jR1pmLT88tzVV9OXHFd5+8RO2fAEqzm67rHBubaNVagw7cgMHHlss/uG5LvO8Isq ojKbuK1rLnC9jzlqQ/vqkbAACF3QI9ZqwIFh1uTcXA== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrfedukedguddtvdcutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpeffhffvvefukfhfgggtuggjsehgtderredttddvnecuhfhrohhmpefrrght rhhitghkucfuthgvihhnhhgrrhguthcuoehpshesphhkshdrihhmqeenucggtffrrghtth gvrhhnpeeukedtvedtffevleejtefgheehieegkeeluddvfeefgeehgfeltddtheejleff teenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehpsh esphhkshdrihhm X-ME-Proxy: Feedback-ID: i197146af:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 14 Jun 2024 02:42:35 -0400 (EDT) Received: by localhost (OpenSMTPD) with ESMTPSA id 15f35879 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Fri, 14 Jun 2024 06:42:17 +0000 (UTC) Date: Fri, 14 Jun 2024 08:42:30 +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 v7 0/4] docs: document upcoming 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: Hi, this is another and hopefully the last version of this patch series that starts to document upcoming breaking changes in Git. Changes compared to v6: - Fix a typo in the third commit. - Document the version number schema and when we bump which part of our version, including historical 1.x days. - Drop the wrong remark that Git 1.6 should've been 2.0. Thanks! Patrick Patrick Steinhardt (4): docs: introduce document to announce breaking changes BreakingChanges: document upcoming change from "sha1" to "sha256" BreakingChanges: document removal of grafting BreakingChanges: document that we do not plan to deprecate git-checkout Documentation/BreakingChanges.txt | 135 ++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 Documentation/BreakingChanges.txt Range-diff against v6: 1: a260bbf281 ! 1: 6348f27b59 docs: introduce document to announce breaking changes @@ Documentation/BreakingChanges.txt (new) +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: ++breaking versions is typically measured in multiple years. We had the following ++major breaking releases in the past: + -+* Git 1.6, released in August 2008. In retrospect, this release should likely -+ have bumped the major version. ++* Git 1.6.0, released in August 2008. +* Git 2.0, released in May 2014. + ++We use . release numbers these days, starting from Git 2.0. For ++future releases, our plan is to increment in the release number when we ++make the next breaking release. Before Git 2.0, the release numbers were ++1.. with the intention to increment for "usual" breaking ++releases, reserving the jump to Git 2.0 for really large backward-compatibility ++breaking changes. ++ +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 2: f7c6a66f71 = 2: d0ec38a25a BreakingChanges: document upcoming change from "sha1" to "sha256" 3: b25b91a5e7 ! 3: deee0bbf66 BreakingChanges: document removal of grafting @@ Documentation/BreakingChanges.txt: Cf. <2f5de416-04ba-c23d-1e0b-83bb655829a7@zom +* 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 are a local-only mechanism and cannot be shared across ++ repositories. + ** Grafts can lead to hard-to-diagnose problems when transferring objects + between repositories. ++ 4: 4fafccc3b9 = 4: 25b20bb0ca BreakingChanges: document that we do not plan to deprecate git-checkout