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

Re: [RFC PATCH] docs: document upcoming breaking changes

From
Patrick Steinhardt <ps@pks.im>
Date
May 8, 2024, 13:55 UTC
Message-ID
<ZjuEPmSq3E28U6tJ@tanuki>
In-Reply-To
<077b69f1-cffa-44d5-8614-7f83b63442f8@gmail.com>
On Wed, May 08, 2024 at 02:15:11PM +0100, Phillip Wood wrote:
Show 26 quoted lines
> Hi Patrick
> 
> Thanks putting this together, I think it will be a useful way discussing
> deprecations and removals.
> 
> On 07/05/2024 09:27, Patrick Steinhardt wrote:
> > 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 lists upcoming breaking changes 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.
> 
> Is the plan to use this document to track the progress/status of proposed
> deprecations? For example the config based hooks implementation is stalled
> at the moment and would need some work before we can remove $GIT_DIR/hooks

I also have it in my backlog to propose a file that may keep a record of long-running projects. The intent would be similar to this patch here, but it should also help newcomers to find projects to work on.

This would track:
  - Large-scale efforts like the past SHA256 migration or removal of
    `the_repository`.
  - Small projects or microprojects like we have in GSoC to help out
    newcomers when they want to work on stuff.
  - Things we have already discussed, but simply didn't get landed yet
    like the hooks refactoring.

So agreed, the hook refactorings should not be part of the deprecations document when it hasn't even landed yet.

Show 18 quoted lines
> > +### Removals
> > +
> > + - git-config(1) has learned to use subcommands that replace implicit actions
> > +   (e.g. `git config foo.bar baz`) as well as the action flags (e.g. `git config
> > +   --unset-all`). The actions will be removed in favor of subcommands.
> > +   Prerequisite for this change is that the new subcommands have been out for at
> > +   least for two years to give script authors time to migrate.
> 
> I agree we want to allow plenty of time for script authors to migrate their
> scripts here.
> 
> > + - githooks(5) can be installed by placing them into `$GIT_DIR/hooks/`. This has
> > +   been a source of multiple remote code execution vulnerabilities.
> 
> I'm not sure about the reasoning here as a hook has to be enabled by the
> user before it is run. There are good reasons to prefer config based hooks
> such as the ability to run multiple scripts per hook event but I don't think
> they are inherently more secure.

I'll remove this item for now. We can discuss it again when (if) the config based mechanisms land.

Patrick
Previous: Phillip WoodNext: Justin Tobler
Message 11 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.