mirror of https://git.wownero.com/dsc/mxe.git
Retire the stable branch, adjust documentation
This commit is contained in:
parent
1b79372c15
commit
dde74e19cf
170
index.html
170
index.html
|
@ -163,9 +163,9 @@
|
|||
|
||||
<p>
|
||||
When everything is fine, download the
|
||||
<a href="#download">current stable version</a>:
|
||||
<a href="#download">current version</a>:
|
||||
</p>
|
||||
<pre>git clone -b stable https://github.com/mxe/mxe.git</pre>
|
||||
<pre>git clone https://github.com/mxe/mxe.git</pre>
|
||||
|
||||
<p>
|
||||
If you don't mind installing it in your home directory,
|
||||
|
@ -437,26 +437,15 @@ USE_OSGPLUGIN(<plugin2>)
|
|||
|
||||
<div class="section">
|
||||
<div id="latest-release"></div>
|
||||
<div id="latest-version"></div>
|
||||
<div id="development"></div>
|
||||
<h2 id="download">Download</h2>
|
||||
|
||||
<p>
|
||||
To obtain the current stable version, run:
|
||||
To obtain the current version, run:
|
||||
</p>
|
||||
|
||||
<pre>git clone -b stable https://github.com/mxe/mxe.git</pre>
|
||||
|
||||
<p>
|
||||
The development version can be obtained by:
|
||||
</p>
|
||||
|
||||
<pre>git clone -b master https://github.com/mxe/mxe.git</pre>
|
||||
|
||||
<p>
|
||||
<strong>N.B.</strong> when using the development version,
|
||||
ensure you use the local documentation (index.html) -
|
||||
the website reflects the stable branch.
|
||||
</p>
|
||||
<pre>git clone https://github.com/mxe/mxe.git</pre>
|
||||
|
||||
<p>
|
||||
To retrieve updates, run:
|
||||
|
@ -480,77 +469,19 @@ USE_OSGPLUGIN(<plugin2>)
|
|||
|
||||
<p>
|
||||
The following <code>.git/config</code> settings ensure
|
||||
that the stable branch will always be pushed to the
|
||||
that the master branch will always be pushed to the
|
||||
<code><a href="https://help.github.com/pages/">gh-pages</a></code>
|
||||
branch in addition to the
|
||||
<code>stable</code> branch,
|
||||
branch,
|
||||
thus ensuring the website will always stay in sync:
|
||||
</p>
|
||||
<pre>[remote "origin"]
|
||||
url = git@github.com:mxe/mxe.git
|
||||
fetch = +refs/heads/*:refs/remotes/origin/*
|
||||
push = refs/heads/master:refs/heads/master
|
||||
push = refs/heads/stable:refs/heads/stable
|
||||
push = refs/heads/stable:refs/heads/gh-pages
|
||||
push = refs/heads/master:refs/heads/gh-pages
|
||||
[branch "master"]
|
||||
remote = origin
|
||||
merge = refs/heads/master
|
||||
[branch "stable"]
|
||||
remote = origin
|
||||
merge = refs/heads/stable</pre>
|
||||
|
||||
<h3 id="branches">Branch Concept</h3>
|
||||
|
||||
<p>
|
||||
For the sake of simplicity, there are just two
|
||||
branches, "master" and "stable". Although it might
|
||||
seem obvious, here's an overview of the types of
|
||||
changes that go into each branch:
|
||||
</p>
|
||||
|
||||
<ul class="compact-list">
|
||||
<li>
|
||||
Any change of a build script goes into "master".
|
||||
</li>
|
||||
<li>
|
||||
Any package upgrade goes into "master".
|
||||
</li>
|
||||
<li>
|
||||
Any documentation upgrade that refers to a feature
|
||||
not present in stable goes into "master".
|
||||
</li>
|
||||
<li>
|
||||
Anything else that doesn't affect the build goes
|
||||
into "stable".
|
||||
</li>
|
||||
<li>
|
||||
Any non-critical improvement to the main Makefile
|
||||
goes into "stable".
|
||||
</li>
|
||||
<li>
|
||||
Any improvement in the package download URLs or
|
||||
package version recognition goes into "stable".
|
||||
</li>
|
||||
<li>
|
||||
When in doubt, "master" is used rather than "stable".
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
And this is how the branches relete to each other:
|
||||
</p>
|
||||
|
||||
<ul class="compact-list">
|
||||
<li>
|
||||
Every change to the "stable" branch
|
||||
will be merged into "master".
|
||||
</li>
|
||||
<li>
|
||||
After a successful testing phase,
|
||||
the "stable" branch
|
||||
will be fast-forwarded to "master".
|
||||
</li>
|
||||
</ul>
|
||||
merge = refs/heads/master</pre>
|
||||
</div>
|
||||
|
||||
<div class="section">
|
||||
|
@ -3128,30 +3059,20 @@ endef</pre>
|
|||
|
||||
<dl>
|
||||
|
||||
<!--
|
||||
<dt>2014-xx-xx – Release <span id="latest-version">2.23</span></dt>
|
||||
<dt>2015-05-04 – Retired the stable branch</dt>
|
||||
<dd>
|
||||
<p>
|
||||
The <a href="#download">stable branch</a> was updated to the
|
||||
current development version after a thorough <a
|
||||
href="https://lists.nongnu.org/archive/html/mingw-cross-env-list/FIXME">testing
|
||||
phase</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Current users are <strong>strongly</strong> encouraged to
|
||||
start with a clean tree as the toolchain has been
|
||||
updated and requires a full rebuild:
|
||||
</p>
|
||||
<pre>git pull && make clean && make</pre>
|
||||
|
||||
<p>
|
||||
Most packages were updated to their latest version.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Many new packages are supported:
|
||||
...
|
||||
The stable branch
|
||||
<a href="https://lists.nongnu.org/archive/html/mingw-cross-env-list/2015-05/msg00004.html">was retired</a>
|
||||
as it
|
||||
<a href="https://lists.nongnu.org/archive/html/mingw-cross-env-list/2015-03/msg00002.html">did more harm than good</a>.
|
||||
Everybody is using the master branch,
|
||||
because it is always recent and well enough tested.
|
||||
For historical reference, the last commit to the stable branch was
|
||||
<a href="https://github.com/mxe/mxe/commits/0c6cc9c91cf94e445ec471a5beebb7199483cb9d" title="0c6cc9c91cf94e445ec471a5beebb7199483cb9d">0c6cc9c</a>,
|
||||
which was
|
||||
<a href="https://github.com/mxe/mxe/commits/eaac1a873f37bdc4f91e1b649e28b118acedc436" title="eaac1a873f37bdc4f91e1b649e28b118acedc436">fully merged into master</a>
|
||||
as usual.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
@ -3192,14 +3113,12 @@ endef</pre>
|
|||
commands should work out-of-the-box assuming the
|
||||
<code>MXE_TARGETS</code> environmental variable is set correctly.
|
||||
</p>
|
||||
|
||||
</dd>
|
||||
-->
|
||||
|
||||
<dt>2013-07-27 – Release <span id="latest-version">2.23</span></dt>
|
||||
<dt>2013-07-27 – Release 2.23</dt>
|
||||
<dd>
|
||||
<p>
|
||||
The <a href="#download">stable branch</a> was updated
|
||||
The stable branch was updated
|
||||
to the current development version after a thorough
|
||||
<a href="https://lists.nongnu.org/archive/html/mingw-cross-env-list/2013-07/msg00021.html">testing phase</a>.
|
||||
</p>
|
||||
|
@ -3249,13 +3168,50 @@ endef</pre>
|
|||
</p>
|
||||
</dd>
|
||||
|
||||
<dt>2012-04-12 – Release 2.22</dt>
|
||||
<dt id="branches">2012-04-12 – Release 2.22</dt>
|
||||
<dd>
|
||||
<p>
|
||||
The release tarballs have been replaced with a <a href="#download">stable branch</a>
|
||||
that conforms to the new <a href="#branches">branch concept</a>.
|
||||
The release tarballs have been replaced with a stable branch
|
||||
that conforms to the new branch concept:
|
||||
</p>
|
||||
|
||||
<ul class="compact-list">
|
||||
<li>
|
||||
Any change of a build script goes into "master".
|
||||
</li>
|
||||
<li>
|
||||
Any package upgrade goes into "master".
|
||||
</li>
|
||||
<li>
|
||||
Any documentation upgrade that refers to a feature
|
||||
not present in stable goes into "master".
|
||||
</li>
|
||||
<li>
|
||||
Anything else that doesn't affect the build goes
|
||||
into "stable".
|
||||
</li>
|
||||
<li>
|
||||
Any non-critical improvement to the main Makefile
|
||||
goes into "stable".
|
||||
</li>
|
||||
<li>
|
||||
Any improvement in the package download URLs or
|
||||
package version recognition goes into "stable".
|
||||
</li>
|
||||
<li>
|
||||
When in doubt, "master" is used rather than "stable".
|
||||
</li>
|
||||
<li>
|
||||
Every change to the "stable" branch
|
||||
will be merged into "master".
|
||||
</li>
|
||||
<li>
|
||||
After a successful testing phase,
|
||||
the "stable" branch
|
||||
will be fast-forwarded to "master".
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
The project has been
|
||||
<a href="http://lists.nongnu.org/archive/html/mingw-cross-env-list/2012-03/msg00101.html">renamed</a>
|
||||
|
|
Loading…
Reference in New Issue