From 5de57e8b26de39a1ab26bb5859f18c8ebf4a2929 Mon Sep 17 00:00:00 2001
From: Paul Bourke <paul.bourke@oracle.com>
Date: Fri, 17 Feb 2017 15:37:59 +0000
Subject: [PATCH] Add docs on how the import branch is named

Change-Id: I86020cb0a9a828953bca69fccea957682ae94696
---
 doc/source/subcommands.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/source/subcommands.rst b/doc/source/subcommands.rst
index a71bd54..e9e5c0c 100644
--- a/doc/source/subcommands.rst
+++ b/doc/source/subcommands.rst
@@ -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
 ~~~~~