Re: document symbols
Jonathan Nieder <jrnieder@gmail.com> writes:
> Hoorah! :) I don't see any problems in the normative content, so I'd
> second this if I could. Cosmetic nits (patch below):
Thanks, applied.
>> + In our example, if the last change to the <tt>zlib1g</tt>
>> + package that could change behavior for a client of that
>> + library was in version <tt>1:1.2.3.3.dfsg-1</tt>, then
>> + the <tt>shlibs</tt> entry for this library could say:
>> + <example compact="compact">
>> + libz 1 zlib1g (>= 1:1.2.3.3.dfsg-1)
>> + </example>
> Should this say (>= 1:1.2.3.3.dfsg-1~) or (>= 1:1.2.3.3.dfsg) to be
> kind to backporters? Before the patch, the example said ">= 1:1.1.3".
Let's go with 1:1.2.3.3.dfsg in the example to show the common case
instead of the unusual case. I've applied this:
commit 29e3fc2e05b59a7e13913a263a1e22d40cbc9918
Author: Russ Allbery <rra@debian.org>
Date: Sun Aug 12 16:32:35 2012 -0700
Reflect the common case in the shlibs example
diff --git a/policy.sgml b/policy.sgml
index 050c688..3c863dc 100644
--- a/policy.sgml
+++ b/policy.sgml
@@ -6796,10 +6796,10 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
<p>
In our example, if the last change to the <tt>zlib1g</tt>
package that could change behavior for a client of that
- library was in version <tt>1:1.2.3.3.dfsg-2</tt>, then
+ library was in version <tt>1:1.2.3.3.dfsg-1</tt>, then
the <tt>shlibs</tt> entry for this library could say:
<example compact="compact">
- libz 1 zlib1g (>= 1:1.2.3.3.dfsg-2~)
+ libz 1 zlib1g (>= 1:1.2.3.3.dfsg)
</example>
This version restriction must be new enough that any binary
built against the current version of the library will work
@@ -6811,7 +6811,7 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
As zlib1g also provides a udeb containing the shared
library, there would also be a second line:
<example compact="compact">
- udeb: libz 1 zlib1g-udeb (>= 1:1.2.3.3.dfsg-2~)
+ udeb: libz 1 zlib1g-udeb (>= 1:1.2.3.3.dfsg)
</example>
</p>
</sect2>
--
Russ Allbery (rra@debian.org) <http://www.eyrie.org/~eagle/>
Reply to: