Repository: guacamole-manual Updated Branches: refs/heads/master 03c612cc2 -> fadba6446
GUACAMOLE-661: Document deprecation of "nest" instruction. Project: http://git-wip-us.apache.org/repos/asf/guacamole-manual/repo Commit: http://git-wip-us.apache.org/repos/asf/guacamole-manual/commit/206400f0 Tree: http://git-wip-us.apache.org/repos/asf/guacamole-manual/tree/206400f0 Diff: http://git-wip-us.apache.org/repos/asf/guacamole-manual/diff/206400f0 Branch: refs/heads/master Commit: 206400f063b7e04e6350fb368fa9506193601b57 Parents: 03c612c Author: Michael Jumper <mjum...@apache.org> Authored: Mon Jan 7 09:47:14 2019 -0800 Committer: Michael Jumper <mjum...@apache.org> Committed: Mon Jan 7 09:47:14 2019 -0800 ---------------------------------------------------------------------- src/references/instructions/server/stream/nest.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/guacamole-manual/blob/206400f0/src/references/instructions/server/stream/nest.xml ---------------------------------------------------------------------- diff --git a/src/references/instructions/server/stream/nest.xml b/src/references/instructions/server/stream/nest.xml index 207d5c7..50119f9 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
