From 1d99c0725c9ba7d815e32b8b5a921b3df078a86a Mon Sep 17 00:00:00 2001
From: Christian Berendt <berendt@b1-systems.de>
Date: Thu, 26 Mar 2015 14:08:49 +0100
Subject: [PATCH] [commands] add a deprecation note for python-keystoneclient

Change-Id: Id99bbef0e9c71568b2dc018221ed2b8a1cb00110
---
 os_doc_tools/commands.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/os_doc_tools/commands.py b/os_doc_tools/commands.py
index 89052ab0..4fc76062 100644
--- a/os_doc_tools/commands.py
+++ b/os_doc_tools/commands.py
@@ -109,6 +109,16 @@ def generate_heading(os_command, api_name, title, os_file):
     <section xml:id=\"%(os_command)sclient_command_usage\">
        <title>%(os_command)s usage</title>\n"""
 
+    if os_command == "keystone":
+        header_deprecation = """
+    <warning>
+        <para>The %(os_command)s CLI is deprecated in favor of
+            python-openstackclient. For a Python library, continue using
+            python-%(os_command)sclient.</para>
+    </warning>\n"""
+    else:
+        header_deprecation = None
+
     format_dict = {
         "os_command": os_command,
         "api_name": api_name,
@@ -117,6 +127,8 @@ def generate_heading(os_command, api_name, title, os_file):
         "help_str": help_str
     }
     os_file.write(header1 % format_dict)
+    if header_deprecation:
+        os_file.write(header_deprecation % format_dict)
     os_file.write(header2 % format_dict)
     os_file.write(header3 % format_dict)