From a26e9820dda7aa57b5d96ee6c75dff8d961dbbf0 Mon Sep 17 00:00:00 2001
From: Matt Riedemann <mriedem.os@gmail.com>
Date: Thu, 1 Jun 2017 14:30:43 -0400
Subject: [PATCH] Document how reno handles eol branches in config

This comes up from time to time so we should probably
document it.

Change-Id: I58fef297612328ee1db61377c29e1cfe0ec6f5ab
---
 doc/source/usage.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index 445e252..51eb650 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -234,7 +234,9 @@ The following options are configurable:
 
 `branch`
 
-  The git branch to scan.
+  The git branch to scan. If a stable branch is specified but does not exist,
+  reno attempts to automatically convert that to an "end-of-life" tag. For
+  example, ``origin/stable/liberty`` would be converted to ``liberty-eol``.
 
   Defaults to the "current" branch checked out.