Skip to content

Commit c268e32

Browse files
committed
BreakingChanges: clarify the procedure
The point behind a compile-time switch is to ensure that we have a mechanism to hide myriad of backward incompatible changes that may be prepared and accumulated over time, yet make them available for testing any time during the development toward the big version boundary. Add a few words to stress that point. Since the document was first written, we have added the CI job that the document anticipated us to have. Rephrase to state the current status. The discussion in [*1*] made us abandon the "feature.git3" based runtime switching of behaviour and instead adopt the compile-time switching mechanism, but a stray sentence about runtime switching still remained in the final text by mistake. Remove it. [Reference] *1* https://lore.kernel.org/git/[email protected]/ Signed-off-by: Junio C Hamano <[email protected]> Acked-by: Patrick Steinhardt <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 2454970 commit c268e32

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

Documentation/BreakingChanges.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,22 +66,21 @@ changes are made at a certain version boundary, and recording these
6666
decisions in this document, are necessary but not sufficient.
6767
Because such changes are expected to be numerous, and the design and
6868
implementation of them are expected to span over time, they have to
69-
be deployable trivially at such a version boundary.
69+
be deployable trivially at such a version boundary, prepared over long
70+
time.
7071

7172
The breaking changes MUST be guarded with the a compile-time switch,
7273
WITH_BREAKING_CHANGES, to help this process. When built with it,
7374
the resulting Git binary together with its documentation would
7475
behave as if these breaking changes slated for the next big version
75-
boundary are already in effect. We may also want to have a CI job
76-
or two to exercise the work-in-progress version of Git with these
77-
breaking changes.
76+
boundary are already in effect. We also have a CI job to exercise
77+
the work-in-progress version of Git with these breaking changes.
7878

7979

8080
== Git 3.0
8181

8282
The following subsections document upcoming breaking changes for Git 3.0. There
83-
is no planned release date for this breaking version yet. The early
84-
adopter configuration used for changes for this release is `feature.git3`.
83+
is no planned release date for this breaking version yet.
8584

8685
Proposed changes and removals only include items which are "ready" to be done.
8786
In other words, this is not supposed to be a wishlist of features that should

0 commit comments

Comments
 (0)