Re: [Pkg-openssl-devel] Bug#719262: [src:openssl] Please review package descriptions
Dear Kurt,
thank you for your prompt response.
>> Pre-Depends: ${misc:Pre-Depends}
>> Depends: ${shlibs:Depends}, ${misc:Depends}
>> -Description: SSL shared libraries
>> - libssl and libcrypto shared libraries needed by programs like
>> - apache-ssl, telnet-ssl and openssh.
>> +Description: Secure Sockets Layer implementation - shared libraries
>> + This package is part of the OpenSSL project's implementation of
the SSL
>> + cryptograpfic protocol for communication security over the internet.
>> .
>> - It is part of the OpenSSL implementation of SSL.
>> + The libssl and libcrypto shared libraries are needed by programs like
>> + apache-ssl, telnet-ssl and openssh.
> I'm not sure mentioning those package is useful, since it gets
> installed as dependency. It doesn't explain what it does. But
> I really have nothing really useful to say about such things.
I just wanted to introduce a unified description, add common boilerplate
and be as minimally invasive as an NMU. But IMHO you are very right. It's a
shared library's nature to be used by several programs. Without explaining
their purpose it is just namedropping.
>> @@ -57,11 +64,12 @@
>> Multi-Arch: same
>> Recommends: libssl-doc
>> Depends: libssl1.0.0 (= ${binary:Version}), zlib1g-dev, ${misc:Depends}
>> -Description: SSL development libraries, header files and documentation
>> - libssl and libcrypto development libraries, header files and manpages.
>> +Description: Secure Sockets Layer implementation - development files
>> + This package is part of the OpenSSL project's implementation of
the SSL
>> + cryptograpfic protocol for communication security over the internet.
>> .
>> - It is part of the OpenSSL implementation of SSL.
>> -
>> + It contains development libraries, header files and manpages for
the libssl
> Maybe it should mention both SSL and TLS.
> Maybe it should make a reference to https?
> Do you think it's useful to also mention things like RSA
> in the description of the shared libraries?
I'm not a computer scientist by education. I don't know anything about
cryptographic protocols. From my Jon Doe POV there is no benefit in
mentioning TLS and HTTPS - at least without shortly explaining them.
Martin
PS: There was a typo in my patch.
--- control.orig 2013-08-08 00:20:03.000000000 +0200
+++ control 2013-08-09 23:45:13.000000000 +0200
@@ -13,12 +13,16 @@
Architecture: any
Depends: ${shlibs:Depends}, ${perl:Depends}, ${misc:Depends}
Suggests: ca-certificates
-Description: Secure Socket Layer (SSL) binary and related cryptographic tools
- This package contains the openssl binary and related tools.
+OpenSSL's Secure Sockets Layer implementation - xxx
+ This package is part of the OpenSSL project's implementation of the SSL
+ cryptographic protocol for communication security over the internet.
+Description: Secure Sockets Layer implementation - binary and related cryptographic tools
+ This package is part of the OpenSSL project's implementation of the SSL
+ cryptographic protocol for communication security over the internet.
.
- It is part of the OpenSSL implementation of SSL.
+ It contains the openssl binary and related tools.
.
- You need it to perform certain cryptographic actions like:
+ You need it to perform cryptographic operations such as:
- Creation of RSA, DH and DSA key parameters;
- Creation of X.509 certificates, CSRs and CRLs;
- Calculation of message digests;
@@ -33,11 +37,12 @@
Multi-Arch: same
Pre-Depends: ${misc:Pre-Depends}
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: SSL shared libraries
- libssl and libcrypto shared libraries needed by programs like
- apache-ssl, telnet-ssl and openssh.
+Description: Secure Sockets Layer implementation - shared libraries
+ This package is part of the OpenSSL project's implementation of the SSL
+ cryptographic protocol for communication security over the internet.
.
- It is part of the OpenSSL implementation of SSL.
+ The libssl and libcrypto shared libraries are needed by programs like
+ apache-ssl, telnet-ssl and openssh.
Package: libcrypto1.0.0-udeb
XC-Package-Type: udeb
@@ -45,10 +50,12 @@
Priority: optional
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: crypto shared library - udeb
- libcrypto shared library.
+Description: Secure Sockets Layer implementation - libcrypto udeb
+ This package is part of the OpenSSL project's implementation of the SSL
+ cryptographic protocol for communication security over the internet.
.
- Do not install it on a normal system.
+ It contains the libcrypto shared library. Do not install it on a normal
+ system.
Package: libssl-dev
Section: libdevel
@@ -57,11 +64,12 @@
Multi-Arch: same
Recommends: libssl-doc
Depends: libssl1.0.0 (= ${binary:Version}), zlib1g-dev, ${misc:Depends}
-Description: SSL development libraries, header files and documentation
- libssl and libcrypto development libraries, header files and manpages.
+Description: Secure Sockets Layer implementation - development files
+ This package is part of the OpenSSL project's implementation of the SSL
+ cryptographic protocol for communication security over the internet.
.
- It is part of the OpenSSL implementation of SSL.
-
+ It contains development libraries, header files and manpages for the libssl
+ and libcrypto libraries.
Package: libssl-doc
Section: doc
@@ -70,10 +78,11 @@
Replaces: libssl-dev (<< 1.0.0)
Breaks: libssl-dev (<< 1.0.0)
Depends: ${shlibs:Depends}, ${perl:Depends}, ${misc:Depends}
-Description: SSL development documentation documentation
- libssl and libcrypto manpages and demo files.
+Description: Secure Sockets Layer implementation - documentation
+ This package is part of the OpenSSL project's implementation of the SSL
+ cryptographic protocol for communication security over the internet.
.
- It is part of the OpenSSL implementation of SSL.
+ It contains libssl and libcrypto manpages and demo files.
Package: libssl1.0.0-dbg
Section: debug
@@ -81,5 +90,8 @@
Architecture: any
Multi-Arch: same
Depends: libssl1.0.0 (= ${binary:Version}), ${misc:Depends}
-Description: Symbol tables for libssl and libcrypto
- This package is part of the OpenSSL implementation of SSL.
+Description: Secure Sockets Layer implementation - debug information
+ This package is part of the OpenSSL project's implementation of the SSL
+ cryptographic protocol for communication security over the internet.
+ .
+ It contains symbol tables for libssl and libcrypto.
Reply to: