Skip to content

docs: document upcoming breaking changes

Patrick Steinhardt requested to merge pks-docs-upcoming-deprecations into master

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, 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 ps@pks.im

Closes Track upcoming deprecations in Git (#318 - closed).

Edited by Patrick Steinhardt

Merge request reports