git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v7 0/4] docs: document upcoming breaking changes

From
Patrick Steinhardt <ps@pks.im>
Date
Jun 14, 2024, 06:42 UTC
Message-ID
<cover.1718345026.git.ps@pks.im>
In-Reply-To
<fc1a9fa03de7330f79dc56b0f2712834cb236b5a.1715070296.git.ps@pks.im>
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 <major>.<minor> release numbers these days, starting from Git 2.0. For
    ++future releases, our plan is to increment <major> in the release number when we
    ++make the next breaking release. Before Git 2.0, the release numbers were
    ++1.<major>.<minor> with the intention to increment <major> 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
-- 
2.45.2.457.g8d94cfb545.dirty
Previous: Patrick SteinhardtNext: Patrick Steinhardt
Message 65 of 70 in “docs: document upcoming breaking changes”
  1. docs: document upcoming breaking changesPatrick Steinhardt, May 7, 2024
  2. Johannes SchindelinMay 7, 2024
  3. Patrick SteinhardtMay 8, 2024
  4. Junio C HamanoMay 7, 2024
  5. Patrick SteinhardtMay 8, 2024
  6. Junio C HamanoMay 8, 2024
  7. Dragan SimicMay 8, 2024
  8. Patrick SteinhardtMay 10, 2024
  9. Dragan SimicMay 10, 2024
  10. Phillip WoodMay 8, 2024
  11. Patrick SteinhardtMay 8, 2024
  12. Justin ToblerMay 10, 2024
  13. Junio C HamanoMay 10, 2024
  14. Patrick SteinhardtMay 14, 2024
  15. docs: document upcoming breaking changesPatrick Steinhardt, May 14, 2024
  16. Karthik NayakMay 14, 2024
  17. Patrick SteinhardtMay 14, 2024
  18. Junio C HamanoMay 14, 2024
  19. Dragan SimicMay 14, 2024
  20. docs: document upcoming breaking changesPatrick Steinhardt, May 24, 2024
  21. Junio C HamanoMay 24, 2024
  22. Patrick SteinhardtMay 30, 2024
  23. 0/4 docs: document upcoming breaking changesPatrick Steinhardt, May 31, 2024
  24. 1/4 docs: introduce document to announce breaking changesPatrick Steinhardt, May 31, 2024
  25. Junio C HamanoMay 31, 2024
  26. Patrick SteinhardtJun 3, 2024
  27. Junio C HamanoJun 3, 2024
  28. Patrick SteinhardtJun 4, 2024
  29. 2/4 BreakingChanges: document upcoming change from "sha1" to "sha256"Patrick Steinhardt, May 31, 2024
  30. Junio C HamanoMay 31, 2024
  31. 3/4 BreakingChanges: document removal of graftingPatrick Steinhardt, May 31, 2024
  32. 4/4 BreakingChanges: document that we do not plan to deprecate git-checkoutPatrick Steinhardt, May 31, 2024
  33. Junio C HamanoMay 31, 2024
  34. Todd ZullingerMay 31, 2024
  35. Junio C HamanoMay 31, 2024
  36. Patrick SteinhardtMay 31, 2024
  37. 0/4 docs: document upcoming breaking changesPatrick Steinhardt, Jun 3, 2024
  38. 1/4 docs: introduce document to announce breaking changesPatrick Steinhardt, Jun 3, 2024
  39. Phillip WoodJun 3, 2024
  40. Junio C HamanoJun 3, 2024
  41. Patrick SteinhardtJun 4, 2024
  42. 2/4 BreakingChanges: document upcoming change from "sha1" to "sha256"Patrick Steinhardt, Jun 3, 2024
  43. Junio C HamanoJun 3, 2024
  44. Patrick SteinhardtJun 4, 2024
  45. Junio C HamanoJun 4, 2024
  46. 3/4 BreakingChanges: document removal of graftingPatrick Steinhardt, Jun 3, 2024
  47. Junio C HamanoJun 3, 2024
  48. 4/4 BreakingChanges: document that we do not plan to deprecate git-checkoutPatrick Steinhardt, Jun 3, 2024
  49. Junio C HamanoJun 3, 2024
  50. Patrick SteinhardtJun 4, 2024
  51. 0/4 docs: document upcoming breaking changesPatrick Steinhardt, Jun 4, 2024
  52. 1/4 docs: introduce document to announce breaking changesPatrick Steinhardt, Jun 4, 2024
  53. Junio C HamanoJun 4, 2024
  54. Patrick SteinhardtJun 5, 2024
  55. Junio C HamanoJun 5, 2024
  56. Junio C HamanoJun 5, 2024
  57. Patrick SteinhardtJun 6, 2024
  58. 2/4 BreakingChanges: document upcoming change from "sha1" to "sha256"Patrick Steinhardt, Jun 4, 2024
  59. 3/4 BreakingChanges: document removal of graftingPatrick Steinhardt, Jun 4, 2024
  60. Junio C HamanoJun 4, 2024
  61. 4/4 BreakingChanges: document that we do not plan to deprecate git-checkoutPatrick Steinhardt, Jun 4, 2024
  62. Phillip WoodJun 4, 2024
  63. Junio C HamanoJun 4, 2024
  64. Patrick SteinhardtJun 5, 2024
  65. 0/4 docs: document upcoming breaking changesPatrick Steinhardt, Jun 14, 2024
  66. 1/4 docs: introduce document to announce breaking changesPatrick Steinhardt, Jun 14, 2024
  67. Junio C HamanoJun 14, 2024
  68. 2/4 BreakingChanges: document upcoming change from "sha1" to "sha256"Patrick Steinhardt, Jun 14, 2024
  69. 3/4 BreakingChanges: document removal of graftingPatrick Steinhardt, Jun 14, 2024
  70. 4/4 BreakingChanges: document that we do not plan to deprecate git-checkoutPatrick Steinhardt, Jun 14, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.