Skip to content

Commit 65b7c09

Browse files
committed
Update install.rst
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.
1 parent 6232476 commit 65b7c09

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/install.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,3 +409,25 @@ installations, such as with ``pip install somepackage``) and ambiguities
409409
between python versions. The testing attempts to run under both Python 2
410410
and Python 3, so you may need to explicitly install packages for each
411411
Python installation.
412+
413+
If you are working in the ``devel`` branch of the repository, note that
414+
the upstream branch may be reset to ``master`` after a new release is
415+
tagged. In general, but particularly on the ``devel`` branch, when you
416+
do a ``git pull``, you should use the ``--rebase`` flag.
417+
418+
If you fetch this repository and then see a git status like this::
419+
420+
$ git status
421+
On branch devel
422+
Your branch and 'origin/devel' have diverged,
423+
and have 31 and 29 different commits each, respectively.
424+
425+
then ``gmxapi`` has probably entered a new development cycle. You can
426+
do ``git pull --rebase`` to update to the latest development branch.
427+
428+
If you do a ``git pull`` while in ``devel`` and get a bunch of unexpected
429+
merge conflicts, do ``git merge --abort; git pull --rebase`` and you should
430+
be back on track.
431+
432+
If you are developing code for gmxapi, this should be an indication to
433+
rebase your feature branches for the new development cycle.

0 commit comments

Comments
 (0)