From 206400f063b7e04e6350fb368fa9506193601b57 Mon Sep 17 00:00:00 2001
From: Michael Jumper <mjumper@apache.org>
Date: Mon, 7 Jan 2019 09:47:14 -0800
Subject: [PATCH] GUACAMOLE-661: Document deprecation of "nest" instruction.

---
 src/references/instructions/server/stream/nest.xml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/references/instructions/server/stream/nest.xml b/src/references/instructions/server/stream/nest.xml
index 207d5c7e..50119f92 100644
--- a/src/references/instructions/server/stream/nest.xml
+++ b/src/references/instructions/server/stream/nest.xml
@@ -6,6 +6,20 @@
     <indexterm>
         <primary>nest</primary>
     </indexterm>
+    <important>
+        <para><emphasis>The <function>nest</function> instruction has been
+            deprecated.</emphasis></para>
+        <para>The <function>nest</function> instruction is no longer necessary, having been replaced
+            by other streaming instructions (such as <link
+                xmlns:xlink="http://www.w3.org/1999/xlink" linkend="blob-instruction"
+                    ><function>blob</function></link>, <link
+                xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ack-instruction"
+                    ><function>ack</function></link>, and <link
+                xmlns:xlink="http://www.w3.org/1999/xlink" linkend="end-instruction"
+                    ><function>end</function></link>). Code using the <function>nest</function>
+            instruction should instead write instructions directly without wrapping those
+            instructions within <function>nest</function>.</para>
+    </important>
     <para>Encodes part of one or more instructions within a single instruction,
         associating that packet of data with a stream index. Future nest
         instructions with the same stream index will append their data to the