Re: template review for curvedns
Stéphane Neveu:
> I'm writing a new debconf template file for a new package. May I ask
> you to review it please ?
Sure!
> Template: curvedns/ask_fqdn
> Type: string
> _Description: Please enter a Fully Qualified Domain Name (FQDN):
The short description doesn't need to be a sentence
("https://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#s6.5.3.2";)
so just make it a prompt describing the kind of string to be entered:
_Description: Fully Qualified Domain Name:
> Before starting curvedns, you must provide your own FQDN.
Is this saying that curvedns won't be started automatically? If so,
maybe move that part to the end where it talks about configuring
/etc/default/curvedns.
I'm also going to assume it means this is "my own" FQDN in the sense of
being the hostname this curvedns server will be available on.
Rehouse the polite wording here:
Please specify the Fully Qualified Domain Name (FQDN) that curvedns will
be available on.
> It will generate private key in /etc/curvedns/env/CURVEDNS_PRIVATE_KEY
If it's talking about a private key generated "from" this FQDN, I'd
suggest phrasing this as:
A corresponding private key will be generated in
"/etc/curvedns/env/CURVEDNS_PRIVATE_KEY".
> See man(1)curvedns-keygen for more information.
The way this is usually formatted is just " - see curvedns-keygen(1)"
or maybe "See the curvedns-keygen man page".
> Next, edit /etc/default/curvedns to fit your needs.
If the server needs to be started manually, say
Next, edit "/etc/default/curvedns" to fit your needs before starting
the server.
So my full revised version is:
Template: curvedns/ask_fqdn
Type: string
_Description: Fully Qualified Domain Name:
Please specify the Fully Qualified Domain Name (FQDN) that curvedns will
be available on. A corresponding private key will be generated in
"/etc/curvedns/env/CURVEDNS_PRIVATE_KEY" - see curvedns-keygen(1).
.
Next, edit "/etc/default/curvedns" to fit your needs before starting the
server.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
Reply to: