Skip to content

Commit 62e619c

Browse files
committed
Minor copyediting of MaintNotes
1 parent 45da69e commit 62e619c

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

MaintNotes

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,16 @@ could occasionally be minor breakages or brown paper bag bugs
7878
but they are not expected to be anything major. Every now and
7979
then, a "feature release" is cut from the tip of this branch and
8080
they typically are named with three dotted decimal digits. The
81-
last such release was v1.5.2 done on May 20th this year.
81+
last such release was v1.5.2 done on May 20th this year. You
82+
can expect that the tip of the "master" branch is always as
83+
stable as any of the released versions, if not more stable.
8284

8385
Whenever a feature release is made, "maint" branch is forked off
8486
from "master" at that point. Obvious, safe and urgent fixes
8587
after a feature release are applied to this branch and
8688
maintenance releases are cut from it. The maintenance releases
8789
are named with four dotted decimal, named after the feature
88-
release they are updates to; the last such release was v1.5.1.6.
90+
release they are updates to; the last such release was v1.5.2.4.
8991
New features never go to this branch. This branch is also
9092
merged into "master" to propagate the fixes forward.
9193

@@ -116,6 +118,8 @@ but is expected to work more or less without major breakage. I
116118
usually use "next" version of git for my own work, so it cannot
117119
be _that_ broken to prevent me from pushing the changes out.
118120
The "next" branch is where new and exciting things take place.
121+
Note that being in "next" does not mean the change will be in
122+
the next feature release.
119123

120124
The above three branches, "master", "maint" and "next" are never
121125
rewound, so you should be able to safely track them (this
@@ -125,7 +129,9 @@ are interested in from the output of "git log next").
125129

126130
The "pu" (proposed updates) branch bundles all the remainder of
127131
topic branches. The "pu" branch, and topic branches that are
128-
only in "pu", are subject to rebasing in general.
132+
only in "pu", are subject to rebasing in general. By the above
133+
definition of how "next" works, you can tell that this branch
134+
will contain quite experimental and obviously broken stuff.
129135

130136
When a topic that was in "pu" proves to be in testable shape, it
131137
graduates to "next". I do this with:
@@ -134,11 +140,11 @@ graduates to "next". I do this with:
134140
git merge that-topic-branch
135141

136142
Sometimes, an idea that looked promising turns out to be not so
137-
hot and the topic can be dropped from "pu" in such a case.
143+
good and the topic can be dropped from "pu" in such a case.
138144

139145
A topic that is in "next" is expected to be tweaked and fixed to
140146
perfection before it is merged to "master" (that's why "master"
141-
can be expected to stay very stable). Similarly to the above I
147+
can be expected to stay very stable). Similarly to the above, I
142148
do it with this:
143149

144150
git checkout master

0 commit comments

Comments
 (0)