[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: b2evolution package: review of debconf template

Xavier Luthi wrote:
> Before uploading the package, may I ask you to review its debconf template?
> Template: b2evolution/db_ask
> Type: boolean
> Default: true
> _Description: Create the database automatically?
>  b2evolution needs a database to be configured and initialized correctly.

Which does this mean:
a) To be configured and initialized correctly, b2evolution requires
	a database (so if you get your answers here wrong, your apt
	session will abort); or
b) b2evolution requires (at runtime) that a database has been
	configured and initialized correctly (so if you get your
	answers here wrong, it will install but won't function).

>From the following the answer appears to be (b), so I'd recommend
rephrasing it as 

   To function, b2evolution needs a correctly configured and initialized

>  This operation can be performed automatically for a MySQL database, if your MySQL server is currently running. You will only be prompted for the database name.

I think I'd find this slightly clearer as:

   For a MySQL database, this operation can be performed automatically,
   if the MySQL server is currently running. You will only be prompted
   for the database name.

(And maybe s/running/accessible/, or something like that?)

>  Automatically creating the database does not make sense if a b2evolution
>  database already exists, or if no database server was configured when
>  b2evolution was installed.

It might be clearer to admins who are actually in this position, but
I don't really follow what that second situation is.  If it's a case
where b2evolution has previously been installed but doesn't (yet)
have access to a database, why is that a reason for rejecting this

>  If you choose to create the database manually, you need to edit /etc/b2evolution/_basic_config.php and set the database-related variables to the appropriate values.
>  .
>  If you're unsure, you should let the package create its database automatically.
> Template: b2evolution/db_name
> Type: string
> Default: b2evolution_debian
> _Description: b2evolution database name:
>  All the tables used by b2evolution will be installed in a new database. Please enter a name that does not correspond to an existing database.

Do people talk about "installing" tables in databases, or should we
stick to "will be created"?
> Template: b2evolution/host
> Type: string
> Default: http://www.example.com/b2evolution
> _Description: URL of your blogs:

Surely they can't _all_ be yours.  Indeed, the webhost might not be
yours either ("you" being the junior assistant sysadmin).  It would
be safer to call it the "b2evolution blog URL" or similar.

>  Note that if you want to test b2evolution locally, do not enter the machine hostname but use 'http://localhost' instead.

I'm sure this would pass unnoticed in speech, but the combination of
that-complement, conditional and imperative is a bit exotic.  And 
there's my usual complaint that you might be obeying orders, not
following personal whims.  How about just:

   To test b2evolution locally, use 'http://localhost' instead of
   the hostname.

> Template: b2evolution/db_remove
> Type: boolean
> _Description: Purge the b2evolution database?
>  If you don't need the b2evolution database (${b2evo_db_name}) any longer, it could be purged automatically. The database user and tables used by b2evolution would be removed.

Maybe "If the b2evolution database (${b2evo_db_name}) is no longer
needed"; definitely s/could/can/.  Likewise, s/would/will/ (or if
that sounds too unconditional, start the second sentence with "In
this case".

By the way, I know you didn't ask, but the package's short description

   a multilingual, multiuser, multi-blog engine

should lose the initial indefinite article (see DevRef 6.2.2):

   multilingual, multiuser, multi-blog engine

JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package

Reply to: