[Pkg-tcltk-commits] r255 - policy

frankie at alioth.debian.org frankie at alioth.debian.org
Sun Oct 14 08:38:44 UTC 2007


Author: frankie
Date: 2007-10-14 08:38:44 +0000 (Sun, 14 Oct 2007)
New Revision: 255

Modified:
   policy/tcltk-policy.sgml
Log:
Introduced default packages, fixed form in some paragraphs and
added useful initial note and an appendix.  


Modified: policy/tcltk-policy.sgml
===================================================================
--- policy/tcltk-policy.sgml	2007-10-13 21:13:37 UTC (rev 254)
+++ policy/tcltk-policy.sgml	2007-10-14 08:38:44 UTC (rev 255)
@@ -14,7 +14,9 @@
     <abstract>
       This document describes the packaging of Tcl/Tk within the Debian
       distribution and the policy requirements for Tcl/Tk extensions
-      and packages. 
+      and packages. This policy has been defined during Lenny release
+      cycle, so pre-Lenny releases can violate this policy in one or 
+      more aspects. Backporters are warned.
 
       THIS IS A DRAFT DOCUMENT, NOT AN OFFICIAL POLICY.
     </abstract>
@@ -59,13 +61,29 @@
 	<p>
 	  At any given time, the virtual packages <package>tclsh</package> and
 	  <package>wish</package> are provided by different source package versions 
-	  of Tcl and Tk. So a default Tcl/Tk exists, but is generally a choice
-	  of the administrator by means of <tt>update-alternatives</tt>
+	  of Tcl and Tk. So pseudo-default Tcl and Tk exist, but they are generally a choice
+	  of the administrator by means of <tt>update-alternatives</tt> use.
+	  Starting from Lenny release, proper default packages are also provided
+	  in order to manage better modules and extensions packaging. 
+	  Modules should preferibly use those packages when appropriate, but it is 
+	  not mandatory. The default packages are
+	  <example>
+	  tcl
+	  tk
+	  tcl-dev
+	  tk-dev
+	  tcl-doc
+	  tk-doc
+	  </example>
 	</p>
 	<p>
 	  The default Debian Tcl/Tk version should alway be the latest stable
 	  upstream release that can be integrated in the distribution. Starting
-	  from 8.0, Tcl and Tk share the same version numbering.
+	  from 8.0, Tcl and Tk share the same version numbering. The default packages
+	  must depend on the right versioned packages and provide useful additional
+	  symlinks and alternatives. At some point in the development cycle 
+	  after Lenny release, virtual packages could be dropped and all packages
+	  have to depend on default packages and/or versioned ones.
 	</p>
 	<p>
 	  Apart from the default version, legacy versions of Tcl/Tk
@@ -96,8 +114,8 @@
 	  <var>modules</var> any Tcl/Tk packages which consist uniquely of 
 	  Tcl/Tk sources, and <var>extension</var> any program which
 	  extends consistently Tcl/Tk using TEA and shared libraries.
-	  This is not completely consistent with Tcl definitions, which
-	  recently also introduced <em>modules</em> and traditionally 
+	  Note that this is not completely consistent with Tcl terminology, 
+	  which recently also introduced <em>.tm modules</em> and traditionally 
 	  deals with <em>packages</em> and <em>script libraries</em>.
 	</p>
 
@@ -172,7 +190,8 @@
 	  </p>
 	  <p>
 	    The maintainer must always consider that the default Tcl/Tk version
-	    is an administrator choice.
+	    could be altered by administrators in the transition period
+	    to default packages.
 	  </p>
         </sect1>
       </sect>
@@ -186,7 +205,8 @@
 	 These packages install
 	<file>/usr/lib/libtcl<var>X</var>.<var>Y</var>.so.<var>Z.</var></file> 
          (soname is <tt>libtcl<var>X</var>.<var>Y</var>.so.<var>Z</var></tt>)
-         and <file>/usr/lib/libtk<var>X</var>.<var>Y</var>.so.<var>Z</var></file>.
+         and <file>/usr/lib/libtk<var>X</var>.<var>Y</var>.so.<var>Z</var></file>
+	 (soname is <tt>libtk<var>X</var>.<var>Y</var>.so.<var>Z</var></tt>).
        </p>
       </sect>
 
@@ -199,7 +219,12 @@
 	  These packages provide header files as well as static and stub libraries.
 	  Header files are installed in <file>/usr/include/tcl<var>X</var>.<var>Y</var>/</file>
 	  and <file>/usr/include/tk<var>X</var>.<var>Y</var>/</file> directories.
-	  There is not a default directory for header files of the default Tcl/Tk.
+	  Default packages <tt>tcl-dev</tt> and <tt>tk-dev</tt> must provide also
+	  symlink for the right versioned header files directory
+	  <example>
+	  /usr/include/tcl -> /usr/include/tclX.Y
+	  /usr/include/tk -> /usr/include/tclX.Y
+	  </example>
         </p>
       </sect>
 
@@ -233,9 +258,12 @@
 	  </taglist>
 	</p>
 	<p>
-	Maintainers must ensure that modules and extensions are correctly installed in the
-	paths above. See <ref id="modules_loading"> also for more information about Tcl/Tk specific
-	ways of dealing with modules and extensions loading.
+	Maintainers must ensure that modules and extensions are correctly installed in subdirs of
+	the paths above consistently. See <ref id="modules_loading"> also for more information 
+	about Tcl/Tk specific ways of dealing with modules and extensions loading.
+	Developers must consider that these defaults impact TEA-based modules and use
+	preferibly system-wide <file>tcl.m4</file> and <file>tclConfig.sh</file> instead
+	of private ones (see <ref id="debian_oddities">).
 	</p>
 
       </sect>
@@ -243,7 +271,9 @@
       <sect id="docs">
 	<heading>Documentation</heading>
 	<p>
-	TO BE COMPLETED
+	Default packages <file>tcl-doc</file> and <file>tk-doc</file> are provided which depend
+	on default versioned <file>tclX.Y-doc</file> and <file>tkX.Y-doc</file>. They both
+	include also a copy of the most up-to-date version of this policy and suitable symlinks.
 	</p>
       </sect>
     </chapt>
@@ -379,5 +409,13 @@
       </p>
     </appendix>
 
+    <appendix id="check_list">
+      <heading>Maintainer's Checklist</heading>
+      <p>
+      TO BE DONE.
+      </p>
+    </appendix>
+
+
   </book>
 </debiandoc>




More information about the Pkg-tcltk-commits mailing list