Bug#822860: p11-kit: package description suggestion

Justin B Rye justin.byam.rye at gmail.com
Thu Apr 28 12:48:12 UTC 2016


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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: pd.patch
Type: text/x-diff
Size: 3765 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/pkg-gnutls-maint/attachments/20160428/93ec4a1e/attachment.patch>


More information about the Pkg-gnutls-maint mailing list