From 0f1d6b3b234a1f8d8c6b9dff38388ab58f695b64 Mon Sep 17 00:00:00 2001
From: William Jon McCann <mccann@jhu.edu>
Date: Tue, 13 Mar 2007 13:50:58 -0400
Subject: deprecate the user properties and add unix-user properties

Also added deprecated notes to the docs.  New code should
be using GetUnixUser instead of GetUser etc.
---
 doc/tools/spec-to-docbook.xsl | 75 +++++++++++++++++++++++++++++++++++++------
 1 file changed, 66 insertions(+), 9 deletions(-)

(limited to 'doc/tools')

diff --git a/doc/tools/spec-to-docbook.xsl b/doc/tools/spec-to-docbook.xsl
index a0959fb..fccf887 100644
--- a/doc/tools/spec-to-docbook.xsl
+++ b/doc/tools/spec-to-docbook.xsl
@@ -108,6 +108,7 @@
   </variablelist>
 
   <xsl:apply-templates select="doc:doc/doc:since"/>
+  <xsl:apply-templates select="doc:doc/doc:deprecated"/>
   <xsl:apply-templates select="doc:doc/doc:permission"/>
   <xsl:apply-templates select="doc:doc/doc:seealso"/>
 </xsl:template>
@@ -145,6 +146,7 @@
   </variablelist>
 
   <xsl:apply-templates select="doc:doc/doc:since"/>
+  <xsl:apply-templates select="doc:doc/doc:deprecated"/>
   <xsl:apply-templates select="doc:doc/doc:permission"/>
   <xsl:apply-templates select="doc:doc/doc:seealso"/>
 </xsl:template>
@@ -199,6 +201,48 @@
 </para>
 </xsl:template>
 
+<xsl:template match="doc:deprecated">
+  <xsl:variable name="name" select="../../@name"/>
+  <xsl:variable name="parent">
+    <xsl:call-template name="interface-basename">
+      <xsl:with-param name="str" select="../../../@name"/>/>
+    </xsl:call-template>
+  </xsl:variable>
+
+  <xsl:variable name="type" select="name(../..)"/>
+
+  <para role="deprecated">
+  <warning><para><literal><xsl:value-of select="$name"/></literal> is deprecated since version <xsl:value-of select="@version"/> and should not be used in newly-written code. Use
+
+  <xsl:variable name="to">
+  <xsl:choose>
+    <xsl:when test="contains($type,'property')">
+      <xsl:value-of select="$parent"/>:<xsl:value-of select="@instead"/>
+    </xsl:when>
+    <xsl:when test="contains($type,'signal')">
+      <xsl:value-of select="$parent"/>::<xsl:value-of select="@instead"/>
+    </xsl:when>
+    <xsl:when test="contains($type,'method')">
+      <xsl:value-of select="$parent"/>.<xsl:value-of select="@instead"/>
+    </xsl:when>
+    <xsl:when test="contains($type,'interface')">
+      <xsl:value-of select="@instead"/>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:value-of select="@instead"/>
+    </xsl:otherwise>
+  </xsl:choose>
+  </xsl:variable>
+
+  <xsl:call-template name="create-link">
+    <xsl:with-param name="type" select="$type"/>
+    <xsl:with-param name="to" select="$to"/>
+    <xsl:with-param name="val" select="@instead"/>
+  </xsl:call-template>
+instead.</para></warning>
+</para>
+</xsl:template>
+
 <xsl:template match="doc:permission">
 <para role="permission">
 <xsl:apply-templates />
@@ -213,23 +257,35 @@ See also:
 </para>
 </xsl:template>
 
-<xsl:template match="doc:ref">
+<xsl:template name="create-link">
+  <xsl:param name="type"/>
+  <xsl:param name="to"/>
+  <xsl:param name="val"/>
+
   <xsl:choose>
-    <xsl:when test="contains(@type,'property')">
-      <link><xsl:attribute name="linkend"><xsl:value-of select="@to"/></xsl:attribute><literal><xsl:apply-templates /></literal></link>
+    <xsl:when test="contains($type,'property')">
+      <link><xsl:attribute name="linkend"><xsl:value-of select="$to"/></xsl:attribute><literal><xsl:value-of select="$val"/></literal></link>
     </xsl:when>
-    <xsl:when test="contains(@type,'signal')">
-      <link><xsl:attribute name="linkend"><xsl:value-of select="@to"/></xsl:attribute><literal><xsl:apply-templates /></literal></link>
+    <xsl:when test="contains($type,'signal')">
+      <link><xsl:attribute name="linkend"><xsl:value-of select="$to"/></xsl:attribute><literal><xsl:value-of select="$val"/></literal></link>
     </xsl:when>
-    <xsl:when test="contains(@type,'method')">
-      <link><xsl:attribute name="linkend"><xsl:value-of select="@to"/></xsl:attribute><function><xsl:apply-templates /></function></link>
+    <xsl:when test="contains($type,'method')">
+      <link><xsl:attribute name="linkend"><xsl:value-of select="$to"/></xsl:attribute><function><xsl:value-of select="$val"/></function></link>
     </xsl:when>
-    <xsl:when test="contains(@type,'interface')">
-      <link><xsl:attribute name="linkend"><xsl:value-of select="@to"/></xsl:attribute><xsl:apply-templates /></link>
+    <xsl:when test="contains($type,'interface')">
+      <link><xsl:attribute name="linkend"><xsl:value-of select="$to"/></xsl:attribute><xsl:value-of select="$val"/></link>
     </xsl:when>
   </xsl:choose>
 </xsl:template>
 
+<xsl:template match="doc:ref">
+  <xsl:call-template name="create-link">
+    <xsl:with-param name="type" select="@type"/>
+    <xsl:with-param name="to" select="@to"/>
+    <xsl:with-param name="val" select="."/>
+  </xsl:call-template>
+</xsl:template>
+
 <xsl:template name="method-doc">
   <xsl:apply-templates select="doc:doc/doc:description"/>
 
@@ -242,6 +298,7 @@ See also:
   </variablelist>
 
   <xsl:apply-templates select="doc:doc/doc:since"/>
+  <xsl:apply-templates select="doc:doc/doc:deprecated"/>
   <xsl:apply-templates select="doc:doc/doc:permission"/>
   <xsl:apply-templates select="doc:doc/doc:seealso"/>
 </xsl:template>
-- 
cgit