From 592394fbcf09e33cf102e83ab385c242126339f4 Mon Sep 17 00:00:00 2001 From: "Davide P. Cervone" Date: Wed, 9 Mar 2011 09:28:55 -0500 Subject: [PATCH] Add info on checking out a release branch via git --- docs/html/_sources/installation.txt | 20 ++++++++++++++++++++ docs/html/installation.html | 16 ++++++++++++++++ docs/source/installation.rst | 20 ++++++++++++++++++++ 3 files changed, 56 insertions(+) diff --git a/docs/html/_sources/installation.txt b/docs/html/_sources/installation.txt index 9044ba95f..df2cbd6ef 100644 --- a/docs/html/_sources/installation.txt +++ b/docs/html/_sources/installation.txt @@ -64,6 +64,26 @@ versions and use ``git checkout `` 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 index 288604099..8dc9ff005 100644 --- a/docs/html/installation.html +++ b/docs/html/installation.html @@ -93,6 +93,22 @@ include all the latest patches and features), use < 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

+
cd MathJax
+git checkout v1.1-latest
+
+
+

and to update it when changes occur, use

+
cd MathJax
+git pull origin v1.1-latest
+
+

Obtaining MathJax via SVNΒΆ

diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 9044ba95f..df2cbd6ef 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -64,6 +64,26 @@ versions and use ``git checkout `` 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: