Package: p11-kit
Version: 0.23.2-3
Severity: wishlist
Tags: patch

This package is automatically installed on any Debian system running
GNOME, but an ordinary user reading the description is unlikely to be
able to guess why, since there's no mention of keyrings or crypto -
just an obscure acronym.  Libraries can get away with this sort of "if
you don't know then you don't need to know" approach to documentation,
but for a toolkit in "misc", you really ought to follow Debian Policy
3.4 and include enough context to let a reader work out approximately
what kind of thing thing the package is good for.

The easiest fix is just to use PKCS#11's full name the first time it's
mentioned in the long description's boilerplate paragraph:

  The p11-kit library provides a way to load and enumerate Public-Key
  Cryptography Standard #11 modules, along with a standard configuration
  setup for installing PKCS#11 modules so that they're discoverable. It
  also solves problems with coordinating the use of PKCS#11 by different
  components or libraries living in the same process.

(Turning these sentence fragments into grammatical sentences has the
side benefit of making it clear that the software being described here
isn't /usr/bin/p11-kit.)
-- 
JBR     with qualifications in linguistics, experience as a Debian
        sysadmin, and probably no clue about this particular package
diff -ru p11-kit-0.23.2.pristine/debian/control p11-kit-0.23.2/debian/control
--- p11-kit-0.23.2.pristine/debian/control	2015-12-27 12:13:05.000000000 +0000
+++ p11-kit-0.23.2/debian/control	2016-04-28 13:40:49.573015713 +0100
@@ -16,12 +16,11 @@
 Architecture: any
 Depends: libp11-kit0 (= ${binary:Version}), ${misc:Depends}
 Multi-Arch: same
-Description: Library for loading and coordinating access to PKCS#11 modules - development
- Provides a way to load and enumerate PKCS#11 modules. Provides a standard
- configuration setup for installing PKCS#11 modules in such a way that
- they're discoverable.
- .
- Also solves problems with coordinating the use of PKCS#11 by different
+Description: library for loading and coordinating access to PKCS#11 modules - development
+ The p11-kit library provides a way to load and enumerate Public-Key
+ Cryptography Standard #11 modules, along with a standard configuration
+ setup for installing PKCS#11 modules so that they're discoverable. It
+ also solves problems with coordinating the use of PKCS#11 by different
  components or libraries living in the same process.
  .
  This package contains the documentation and development headers required
@@ -33,12 +32,11 @@
 Pre-Depends: ${misc:Pre-Depends}
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Multi-Arch: same
-Description: Library for loading and coordinating access to PKCS#11 modules - runtime
- Provides a way to load and enumerate PKCS#11 modules. Provides a standard
- configuration setup for installing PKCS#11 modules in such a way that
- they're discoverable.
- .
- Also solves problems with coordinating the use of PKCS#11 by different
+Description: library for loading and coordinating access to PKCS#11 modules - runtime
+ The p11-kit library provides a way to load and enumerate Public-Key
+ Cryptography Standard #11 modules, along with a standard configuration
+ setup for installing PKCS#11 modules so that they're discoverable. It
+ also solves problems with coordinating the use of PKCS#11 by different
  components or libraries living in the same process.
  .
  This package contains the shared library required for applications loading
@@ -49,11 +47,10 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, p11-kit-modules (>= ${source:Version})
 Description: p11-glue utilities
- Provides a way to load and enumerate PKCS#11 modules. Provides a standard
- configuration setup for installing PKCS#11 modules in such a way that
- they're discoverable.
- .
- Also solves problems with coordinating the use of PKCS#11 by different
+ The p11-kit library provides a way to load and enumerate Public-Key
+ Cryptography Standard #11 modules, along with a standard configuration
+ setup for installing PKCS#11 modules so that they're discoverable. It
+ also solves problems with coordinating the use of PKCS#11 by different
  components or libraries living in the same process.
  .
  This package contains the p11-kit tool for listing PKCS#11 modules.
@@ -66,11 +63,10 @@
 Replaces: p11-kit (<= 0.20.2-1)
 Multi-Arch: same
 Description: p11-glue proxy and trust modules
- Provides a way to load and enumerate PKCS#11 modules. Provides a standard
- configuration setup for installing PKCS#11 modules in such a way that
- they're discoverable.
- .
- Also solves problems with coordinating the use of PKCS#11 by different
+ The p11-kit library provides a way to load and enumerate Public-Key
+ Cryptography Standard #11 modules, along with a standard configuration
+ setup for installing PKCS#11 modules so that they're discoverable. It
+ also solves problems with coordinating the use of PKCS#11 by different
  components or libraries living in the same process.
  .
  This package contains the p11-kit proxy module and the system trust

Reply via email to