Add docs on how the import branch is named

Change-Id: I86020cb0a9a828953bca69fccea957682ae94696
This commit is contained in:
Paul Bourke 2017-02-17 15:37:59 +00:00 committed by Paul Bourke (pbourke)
parent e4190ff279
commit 5de57e8b26
1 changed files with 12 additions and 0 deletions

View File

@ -16,6 +16,18 @@ specified strategy. Once complete it will merge and replace the contents
of the target branch with those from the import branch, unless
``--no-merge`` is specified.
By default, the import branch is named according to the following
format, unless overridden using ``--import-branch``:
::
import/<tag-or-git-describe-commit>[-<additional-branch-git-describe-commit>]
For example, ``import/4.0.0.0rc1-8-geaec95b`` refers to an upstream
branch who's latest tag is ``4.0.0.0rc1``. ``8`` commits have been made
upstream ahead of this tag, and ``geaec95b`` is SHA1 of the tip before
import.
Usage
~~~~~