From 55b89aacf0291dd3fea8771d8bef75efb8e64b4d Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Sun, 12 Aug 2012 16:30:54 -0700 Subject: [PATCH] symbols/shlibs policy: cosmetic fixes Use "zlib1g (>= 1:1.2.3.3.dfsg-2~)" in the sample shlibs dependency field to emphasize the backport-friendly convention described in the sharedlibs-updates section. Also correct two small typos --- one sentence is uncapitalized and another missing a noun --- and rephrase a sentence that describes when to bump the dependency-version to make it easier to read. --- policy.sgml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/policy.sgml b/policy.sgml index fa1c39a..050c688 100644 --- a/policy.sgml +++ b/policy.sgml @@ -5646,7 +5646,7 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)

To determine the soversion, look at the SONAME of the library, stored in the - ELF SONAME attribute. it is usually of the + ELF SONAME attribute. It is usually of the form name.so.major-version (for example, libz.so.1). The version part is the part which comes after .so., so in that example it @@ -6238,9 +6238,9 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)

- A common example of when a change to the is required is a - function that takes an enum or struct argument that controls - what the function does. For example: + A common example of when a change to the dependency version + is required is a function that takes an enum or struct + argument that controls what the function does. For example: enum library_op { OP_FOO, OP_BAR }; int library_do_operation(enum library_op); @@ -6489,8 +6489,9 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1) recent version of the shared library that changed the behavior of that symbol, whether by adding it, changing its function signature (the parameters, their types, or the - return type), or its behavior in a way that is visible to a - caller. id-of-dependency-template is an optional + return type), or changing its behavior in a way that is + visible to a caller. + id-of-dependency-template is an optional field that references an alternative-dependency-template; see below for a full description. @@ -6795,10 +6796,10 @@ Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)

In our example, if the last change to the zlib1g package that could change behavior for a client of that - library was in version 1:1.2.3.3.dfsg-1, then + library was in version 1:1.2.3.3.dfsg-2, then the shlibs entry for this library could say: - libz 1 zlib1g (>= 1:1.2.3.3.dfsg-1) + libz 1 zlib1g (>= 1:1.2.3.3.dfsg-2~) This version restriction must be new enough that any binary built against the current version of the library will work @@ -6810,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: - udeb: libz 1 zlib1g-udeb (>= 1:1.2.3.3.dfsg-1) + udeb: libz 1 zlib1g-udeb (>= 1:1.2.3.3.dfsg-2~)

-- 2.39.2