Please find, for review, the debconf templates and packages descriptions for the ssl-cert source package.
This review will last from Sunday, September 23, 2007 to Wednesday, October 03, 2007.
Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.
Your review should be sent as an answer to this mail.
When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.
When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.
Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.
Rationale:
--- ../ssl-cert.old/debian/templates 2007-09-16 22:51:16.004883799 +0200
+++ debian/templates 2007-09-19 07:20:49.014454823 +0200
@@ -1,48 +1,66 @@
Template: make-ssl-cert/countryname
Type: string
-_Default: GB
-_Description: Country Name
- The two letter code for your Country. (e.g. GB) (countryName)
+_DefaultChoice: GB
+_Description: Country code:
+ Please enter the two-letter ISO-3166 code to use in the SSL certificate.
+ .
+ It will become the 'countryName' field of the generated SSL certificate.
The default should be different with languages. That's what
DefaultChoice is for.
Here, just like *all* other templates descriptions, I:
- add a colon at the end (lintian warns about this)
- remove extra capitals
- make a *sentence* in the long description with the quite common
"Please enter"
- split the template in two parts for readability, with the last part
being more specific about what "countryName"-like things are
For that specific template, what's prompted is the country code, not
the name. We have to explain that it should be the ISO-3166 code and
not the product of the imagination of the reader..:)
Similar changes to all other templates. I won't comment them except
when some specific thing comes up.
Template: make-ssl-cert/localityname
Type: string
-_Default: Some-Locality
-_Description: Locality Name
- The name of the city or town that you live in. (localityName)
+_DefaultChoice: Some-Locality
+_Description: Locality name:
+ Please enter the name of the city or town to use in the SSL
+ certificate.
+ .
+ It will become the 'localityName' field of the generated SSL certificate.
Remove the "you live in". The point is prompting for the coty name in
the certificate. It's up to the reader to decide whether that should
be the town (s)he lives in or the town the server is hosted in or
whatever else.
Template: make-ssl-cert/hostname
Type: string
Default: localhost
-_Description: Host Name
- The host name of the server the certificate is for. This must be filled
- in. (commonName)
+_Description: Host name:
+ Please enter the host name to use in the SSL certificate.
+ .
+ It will become the 'commonName' field of the generated SSL certificate.
+ .
+ This value is mandatory.
Split the mandatory on its own paragraph to make it proeminent (and
common to other templates, if needed).
Template: make-ssl-cert/title
Type: title
-_Description: Configure an SSL Certificate.
+_Description: Configure an SSL certificate
No ending dots in titles. Uncapitalize.
--- ../ssl-cert.old/debian/control 2007-09-16 22:51:16.004883799 +0200
+++ debian/control 2007-09-19 07:22:13.010078901 +0200
@@ -9,8 +9,9 @@
Package: ssl-cert
Architecture: all
Depends: ${misc:Depends}, openssl, adduser
-Description: Simple debconf wrapper for openssl
- This is a package to enable unattended installs of software that
- need to create ssl certificates.
- Basically, it's just a wrapper for openssl req that feeds it the correct
- user variables.
+Description: simple debconf wrapper for OpenSSL
+ This package enables unattended installs of software that
+ need to create SSL certificates.
+ .
+ It is a simple wrapper for OpenSSL's certificate request utility that
+ feeds it with the correct user variables.
remove initial capital in the short description
Avoid "This is <foo>" and use "This package provides" or similar
construction.
Avoid jargon by explaining what is "req". Remove useless "basically"
--
Template: make-ssl-cert/countryname Type: string _DefaultChoice: GB _Description: Country code: Please enter the two-letter ISO-3166 code to use in the SSL certificate. . It will become the 'countryName' field of the generated SSL certificate. Template: make-ssl-cert/statename Type: string _DefaultChoice: Some-State _Description: State or province name: Please enter the name of the country's subdivision to use in the SSL certificate. . It will become the 'stateOrProvinceName' field of the generated SSL certificate. Template: make-ssl-cert/localityname Type: string _DefaultChoice: Some-Locality _Description: Locality name: Please enter the name of the city or town to use in the SSL certificate. . It will become the 'localityName' field of the generated SSL certificate. Template: make-ssl-cert/organisationname Type: string _DefaultChoice: One Organization _Description: Organisation name: Please enter the name of the company or organization to use in the SSL certificate. . It will become the 'organisationName' field of the generated SSL certificate. Template: make-ssl-cert/ouname Type: string _DefaultChoice: One Organization Unit _Description: Organisational unit name: Please enter the name of the division or section of the organization, to use in the SSL certificate. . It will become the 'organisationalUnitName' field of the generated SSL certificate. Template: make-ssl-cert/hostname Type: string Default: localhost _Description: Host name: Please enter the host name to use in the SSL certificate. . It will become the 'commonName' field of the generated SSL certificate. . This value is mandatory. Template: make-ssl-cert/email Type: string Default: webmaster@localhost _Description: Email address: Please enter the email address to use in the SSL certificate. . It will become the 'email' field of the generated SSL certificate. Template: make-ssl-cert/title Type: title _Description: Configure an SSL certificate
--- ../ssl-cert.old/debian/templates 2007-09-16 22:51:16.004883799 +0200
+++ debian/templates 2007-09-19 07:20:49.014454823 +0200
@@ -1,48 +1,66 @@
Template: make-ssl-cert/countryname
Type: string
-_Default: GB
-_Description: Country Name
- The two letter code for your Country. (e.g. GB) (countryName)
+_DefaultChoice: GB
+_Description: Country code:
+ Please enter the two-letter ISO-3166 code to use in the SSL certificate.
+ .
+ It will become the 'countryName' field of the generated SSL certificate.
Template: make-ssl-cert/statename
Type: string
-_Default: Some-State
-_Description: State or Province Name
- Your state, county or province. (stateOrProvinceName)
+_DefaultChoice: Some-State
+_Description: State or province name:
+ Please enter the name of the country's subdivision to use in the SSL
+ certificate.
+ .
+ It will become the 'stateOrProvinceName' field of the generated SSL
+ certificate.
Template: make-ssl-cert/localityname
Type: string
-_Default: Some-Locality
-_Description: Locality Name
- The name of the city or town that you live in. (localityName)
+_DefaultChoice: Some-Locality
+_Description: Locality name:
+ Please enter the name of the city or town to use in the SSL
+ certificate.
+ .
+ It will become the 'localityName' field of the generated SSL certificate.
Template: make-ssl-cert/organisationname
Type: string
-_Default: One Organization
-_Description: Organisation Name
- The name of the company or organisation the certificate is for.
- (organisationName)
+_DefaultChoice: One Organization
+_Description: Organisation name:
+ Please enter the name of the company or organization to use in the SSL
+ certificate.
+ .
+ It will become the 'organisationName' field of the generated SSL certificate.
Template: make-ssl-cert/ouname
Type: string
-_Default: One Organization Unit
-_Description: Organisational Unit Name
- The Division or section of the organisation the certificate is for.
- (organisationalUnitName)
+_DefaultChoice: One Organization Unit
+_Description: Organisational unit name:
+ Please enter the name of the division or section of the organization, to use
+ in the SSL certificate.
+ .
+ It will become the 'organisationalUnitName' field of the generated SSL certificate.
Template: make-ssl-cert/hostname
Type: string
Default: localhost
-_Description: Host Name
- The host name of the server the certificate is for. This must be filled
- in. (commonName)
+_Description: Host name:
+ Please enter the host name to use in the SSL certificate.
+ .
+ It will become the 'commonName' field of the generated SSL certificate.
+ .
+ This value is mandatory.
Template: make-ssl-cert/email
Type: string
Default: webmaster@localhost
-_Description: Email Address
- The email address that should be associated with the certificate.
+_Description: Email address:
+ Please enter the email address to use in the SSL certificate.
+ .
+ It will become the 'email' field of the generated SSL certificate.
Template: make-ssl-cert/title
Type: title
-_Description: Configure an SSL Certificate.
+_Description: Configure an SSL certificate
--- ../ssl-cert.old/debian/control 2007-09-16 22:51:16.004883799 +0200
+++ debian/control 2007-09-19 07:22:13.010078901 +0200
@@ -9,8 +9,9 @@
Package: ssl-cert
Architecture: all
Depends: ${misc:Depends}, openssl, adduser
-Description: Simple debconf wrapper for openssl
- This is a package to enable unattended installs of software that
- need to create ssl certificates.
- Basically, it's just a wrapper for openssl req that feeds it the correct
- user variables.
+Description: simple debconf wrapper for OpenSSL
+ This package enables unattended installs of software that
+ need to create SSL certificates.
+ .
+ It is a simple wrapper for OpenSSL's certificate request utility that
+ feeds it with the correct user variables.
Source: ssl-cert
Section: utils
Priority: optional
Maintainer: Debian Apache Maintainers <debian-apache@lists.debian.org>
Uploaders: Tollef Fog Heen <tfheen@debian.org>, Thom May <thom@debian.org>, Fabio M. Di Nitto <fabbione@fabbione.net>, Adam Conrad <adconrad@0c3.net>
Build-Depends-Indep: debhelper (>= 4.1.16)
Standards-Version: 3.6.1
Package: ssl-cert
Architecture: all
Depends: ${misc:Depends}, openssl, adduser
Description: simple debconf wrapper for OpenSSL
This package enables unattended installs of software that
need to create SSL certificates.
.
It is a simple wrapper for OpenSSL's certificate request utility that
feeds it with the correct user variables.
Attachment:
signature.asc
Description: Digital signature