Skip to content

Commit

Permalink
Update install.rst
Browse files Browse the repository at this point in the history
Add some notes about tracking the ``devel`` branch across releases. ``git pull --rebase`` seems to do the right thing. ``git pull`` may not.

Users who have cloned the repository but who have not checked out the ``devel`` branch should not be affected.

Tested with ``git 2.15.2``. Some users may already ``git pull --rebase`` as a default.
  • Loading branch information
eirrgang committed Jul 25, 2018
1 parent 6232476 commit 65b7c09
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -409,3 +409,25 @@ installations, such as with ``pip install somepackage``) and ambiguities
between python versions. The testing attempts to run under both Python 2
and Python 3, so you may need to explicitly install packages for each
Python installation.

If you are working in the ``devel`` branch of the repository, note that
the upstream branch may be reset to ``master`` after a new release is
tagged. In general, but particularly on the ``devel`` branch, when you
do a ``git pull``, you should use the ``--rebase`` flag.

If you fetch this repository and then see a git status like this::

$ git status
On branch devel
Your branch and 'origin/devel' have diverged,
and have 31 and 29 different commits each, respectively.

then ``gmxapi`` has probably entered a new development cycle. You can
do ``git pull --rebase`` to update to the latest development branch.

If you do a ``git pull`` while in ``devel`` and get a bunch of unexpected
merge conflicts, do ``git merge --abort; git pull --rebase`` and you should
be back on track.

If you are developing code for gmxapi, this should be an indication to
rebase your feature branches for the new development cycle.

0 comments on commit 65b7c09

Please sign in to comment.