[Pkg-tcltk-commits] r346 - policy/trunk
sgolovan-guest at alioth.debian.org
sgolovan-guest at alioth.debian.org
Sat Oct 20 20:44:49 UTC 2007
Author: sgolovan-guest
Date: 2007-10-20 20:44:49 +0000 (Sat, 20 Oct 2007)
New Revision: 346
Modified:
policy/trunk/tcltk-policy.sgml
Log:
[policy]
1) Clarified dependencies.
2) Use defined entities across the whole text.
Modified: policy/trunk/tcltk-policy.sgml
===================================================================
--- policy/trunk/tcltk-policy.sgml 2007-10-20 19:49:11 UTC (rev 345)
+++ policy/trunk/tcltk-policy.sgml 2007-10-20 20:44:49 UTC (rev 346)
@@ -314,7 +314,7 @@
If the package already uses the name
<package>tcl<var>foo</var></package> or <package>tk<var>foo</var></package>, that is,
naming without Tcl/Tk versioning even if version-dependent and/or without hyphen, may use
- the name for now. However, the new package naming is recommended for consistency.
+ the name for now. However, the package naming proposed above is recommended for consistency.
</p>
</sect>
@@ -322,20 +322,17 @@
<heading>Dependencies</heading>
<p>
Packaged modules available for one particular version of Tcl/Tk must
- depend on the corresponding
- <package>tcl<var>X</var>.<var>Y</var></package> and/or
- <package>tk<var>X</var>.<var>Y</var></package>
- package. They can depend on both the default version and
- the virtual <package>tclsh</package> or <package>tk</package>
- packages when they are version independent. Those virtual packages
- could be dropped after Lenny release, so their use is deprecated.
- Due to limitations in current autobuild daemon
- it is mandatory to prepend a preferred Tcl/Tk version before each of the virtual packages.
- The preferred version should correspond to the current default Tcl/Tk.
- Preferably packaged modules should instead depend on the default tcl and tk packages with
- or without version relationships when appropriate. This is the recommended dependency
- style.
+ depend on the corresponding &tclXY; and/or &tkXY; package.
</p>
+ <p>
+ The recommended dependencies of version-independent packages are the following:
+ If the package works in all available Tcl/Tk versions it should depend on
+ &tcl; (>= &XY;) | &tclsh; or &tk; (>= &XY;) | &wish; (version in parentheses is optional).
+ If the package works with current and future Tcl/Tk versions it should depend on
+ the default packages &tcl; or &tk;.
+ It isn't recommended to use dependency on virtual packages &tclsh; and &wish; only
+ because it would make transition to a newer default Tcl/Tk version less convenient.
+ </p>
</sect>
<chapt id="programs">
@@ -346,9 +343,9 @@
<p>
Programs that can run with any version of Tcl/Tk should be started
with <tt>#!/usr/bin/tclsh</tt> or <tt>#!/usr/bin/wish</tt>.
- They must also specify a dependency on <package>tclsh</package> or
- <package>wish</package> virtual packages (deprecated) or on default
- packages (better).
+ They must also specify a dependency on default
+ packages &tcl; and/or &tk; with possible alternatives &tclsh; and/or
+ &wish; virtual packages.
You're free to use <tt>#!/usr/bin/env tclsh</tt> and <tt>#!/usr/bin/env wish</tt>,
if you'd like to give the user a chance to override the Debian Tcl/Tk package with a
@@ -360,14 +357,14 @@
<heading>Version Dependent Programs</heading>
<p>
Programs which require a specific version of Tcl must start with
- <tt>#!/usr/bin/tclsh<var>X</var>.<var>Y</var></tt>. They must also
- specify a strict dependency on <package>tcl<var>X</var>.<var>Y</var></package>.
+ <tt>#!/usr/bin/tclsh&XY;</tt>. They must also
+ specify a strict dependency on &tclXY;.
Programs which require a specific version of Tk must start with
- <tt>#!/usr/bin/wish<var>X</var>.<var>Y</var></tt>. They must also
- specify a strict dependency on <package>tk<var>X</var>.<var>Y</var></package>.
+ <tt>#!/usr/bin/wish&XY;</tt>. They must also
+ specify a strict dependency on &tkXY;.
- Again, if you're using <tt>#!/usr/bin/env tclsh<var>X</var>.<var>Y</var></tt>,
- or <tt>#!/usr/bin/env wish<var>X</var>.<var>Y</var></tt>
+ Again, if you're using <tt>#!/usr/bin/env tclsh&XY;</tt>,
+ or <tt>#!/usr/bin/env wish&XY;</tt>
please be aware that a user might override the Debian Tcl/Tk packages with a local version
and that release default packages can change also.
</p>
@@ -392,8 +389,8 @@
<example>
tcl-dev
tk-dev
- tcl<var>X</var>.<var>Y</var>-dev
- tk<var>X</var>.<var>Y</var>-dev
+ tcl&XY;-dev
+ tk&XY;-dev
</example>
</p>
<p>
@@ -408,8 +405,8 @@
<example>
tcl
tk
- tcl<var>X</var>.<var>Y</var>
- tk<var>X</var>.<var>Y</var>
+ tcl&XY;
+ tk&XY;
</example>
</p>
<p>
@@ -420,10 +417,10 @@
</example>
</p>
<p>
- Do not use build dependencies on the virtual packages
- <package>tclsh</package> or
- <package>wish</package> as they cannot guarantee the same build environment.
- Use default packages instead.
+ Due to limitations of current autobuild daemon
+ it is forbidden to use build dependencies on the virtual packages
+ &tclsh; or &wish; only. These dependencies cannot guarantee consistent build environment,
+ so it is mandatory to prepend a preferred Tcl/Tk version before each of the virtual packages.
</p>
</appendix>
@@ -455,8 +452,8 @@
Extensions using TEA with local copies of <file>tcl.m4</file>,
or which use custom guesses about Tcl/Tk configuration could require explicit use of
<example>
- --with-tcl=/usr/share/tcltk/tclX.Y
- --with-tk=/usr/share/tcltk/tkX.Y
+ --with-tcl=/usr/share/tcltk/tcl&XY;
+ --with-tk=/usr/share/tcltk/tk&XY;
</example>
or other custom hacks.
</p>
@@ -473,11 +470,11 @@
Scripts can include a <file>package require ?-exact? Tcl X.Y</file> or
<file>package require ?-exact? Tk X.Y</file>, for instance.
In those cases, use a versioned
- dependency on one of the default packages (<file>tcl</file>, <file>tk</file>, <file>tcl-dev</file> or
- <file>tk-dev</file>), e.g. <file>tcl (>= X.Y)</file>.
+ dependency on one of the default packages (&tcl;, &tk;, &tcl-dev; or
+ &tk-dev;), e.g. &tcl; (>= &XY;).
That is recommend instead of versioned packages dependencies, which are anyway
- supported for compatibility with past conventions. Note also that <file>tk</file>
- depends on <file>tcl</file> and <file>tk-dev</file> depends on <file>tcl-dev</file>.
+ supported for compatibility with past conventions. Note also that &tk;
+ depends on &tcl; and &tk-dev; depends on &tcl-dev;.
</item>
<item>
Always install your package stuff in a per-package sub-directory of
@@ -485,8 +482,8 @@
shared library extensions) along with the needed index file (see <ref id="modules_loading">).
</item>
<item>
- This policy customizes <file>auto_path</file> differently with respect to
- generic upstream <file>UNIX</file> platforms, so that you should use preferably
+ This policy customizes <var>auto_path</var> differently with respect to
+ generic upstream UNIX platforms, so that you should use preferably
system provided <file>tcl.m4</file> or <file>tclConfig.sh</file>. Occasionally
that could either require custom hacks for non TEA-based building systems, or
using <file>--with-tcl</file> or <file>--with-tk</file> argument for TEA scripts.
More information about the Pkg-tcltk-commits
mailing list