commit 592394fbcf09e33cf102e83ab385c242126339f4
parent d5b6366f371d27826d49303a8caa3907ef426d9a
Author: Davide P. Cervone <dpvc@union.edu>
Date: Wed, 9 Mar 2011 09:28:55 -0500
Add info on checking out a release branch via git
Diffstat:
3 files changed, 56 insertions(+), 0 deletions(-)
diff --git a/docs/html/_sources/installation.txt b/docs/html/_sources/installation.txt
@@ -64,6 +64,26 @@ versions and use ``git checkout <tag_name>`` to checkout that version of
MathJax. When you want to upgrade to a new release, you will need to
repeat this for the latest release tag.
+Each of the tagged releases also has a branch in which critical updates
+are applied (we try hard not to patch the stable releases, but sometimes
+there is a crucial change that needs to be made). If you want to use the
+patched version of a release, then check out the branch rather than the
+tag. The branch name is the same as the tag, but with ``-latest``
+appended; so for the ``v1.1`` tag, the branch would be ``v1.1-latest``.
+To get this release, use
+
+.. code-block:: sh
+
+ cd MathJax
+ git checkout v1.1-latest
+
+and to update it when changes occur, use
+
+.. code-block:: sh
+
+ cd MathJax
+ git pull origin v1.1-latest
+
.. _getting-mathjax-svn:
diff --git a/docs/html/installation.html b/docs/html/installation.html
@@ -93,6 +93,22 @@ include all the latest patches and features), use <tt class="docutils literal"><
versions and use <tt class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre"><tag_name></span></tt> to checkout that version of
MathJax. When you want to upgrade to a new release, you will need to
repeat this for the latest release tag.</p>
+<p>Each of the tagged releases also has a branch in which critical updates
+are applied (we try hard not to patch the stable releases, but sometimes
+there is a crucial change that needs to be made). If you want to use the
+patched version of a release, then check out the branch rather than the
+tag. The branch name is the same as the tag, but with <tt class="docutils literal"><span class="pre">-latest</span></tt>
+appended; so for the <tt class="docutils literal"><span class="pre">v1.1</span></tt> tag, the branch would be <tt class="docutils literal"><span class="pre">v1.1-latest</span></tt>.
+To get this release, use</p>
+<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>MathJax
+git checkout v1.1-latest
+</pre></div>
+</div>
+<p>and to update it when changes occur, use</p>
+<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>MathJax
+git pull origin v1.1-latest
+</pre></div>
+</div>
</div>
<div class="section" id="obtaining-mathjax-via-svn">
<span id="getting-mathjax-svn"></span><h2>Obtaining MathJax via SVN<a class="headerlink" href="#obtaining-mathjax-via-svn" title="Permalink to this headline">ΒΆ</a></h2>
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -64,6 +64,26 @@ versions and use ``git checkout <tag_name>`` to checkout that version of
MathJax. When you want to upgrade to a new release, you will need to
repeat this for the latest release tag.
+Each of the tagged releases also has a branch in which critical updates
+are applied (we try hard not to patch the stable releases, but sometimes
+there is a crucial change that needs to be made). If you want to use the
+patched version of a release, then check out the branch rather than the
+tag. The branch name is the same as the tag, but with ``-latest``
+appended; so for the ``v1.1`` tag, the branch would be ``v1.1-latest``.
+To get this release, use
+
+.. code-block:: sh
+
+ cd MathJax
+ git checkout v1.1-latest
+
+and to update it when changes occur, use
+
+.. code-block:: sh
+
+ cd MathJax
+ git pull origin v1.1-latest
+
.. _getting-mathjax-svn:
