Re: Proposed new debconf template for docbookwiki
Jeremy Malcolm wrote:
> Thanks for your recent work in reviewing the docbookwiki package
> templates, for which translations are now still streaming in. I'm
> about to make a change which will mean another text to translate
> (sorry!). It's been suggested by the upstream developer (though there
> is no Debian bug for this) that since MySQL is no longer used by
> docbookwiki, it is too much overhead to depend on dbconfig just for
> removal of the old database on purge.
Are dependencies guaranteed to be available at purge time anyway?
> So I'm proposing to add this message if the old database is found
> when installing:
First question: does it need to be a debconf note? I don't want to
have to stop and fetch a pen and paper to write things down halfway
through a dist-upgrade if instead it could be available as
/usr/share/doc/docbookwiki/NEWS.Debian (which apt-listchanges would
email me about anyway)...
So I'd suggest getting rid of it entirely; if not, I'd recommend
backing it up with a mention in the docs (which would mean you could
reduce this message to a pointer); but just in case you don't take my
advice here's a review following our usual Smith Project styleguide.
> Template: docbookwiki/webnotes_warning
> Type: note
> _Description: Web notes are no longer supported
> Your system contains a database for Web notes, from an earlier version of
> DocBook Wiki. These are no longer supported in the current version. If
> you wish to remove the existing database, either now or when later purging
> this package, you may do so by issuing the following command and typing the
> password for the administrative user of MySQL:
> echo "drop database webnotes" | mysql -uroot -p
Upstream seems to use both "DocBook Wiki" and "DocBookWiki", but it's
the latter in the package description and the other templates.
Any particular reason for capitalising "Web notes"?
We normally standardise on singlespaced sentences in templates.
We try to avoid talking about "your system" and asking what "you wish
to" do - after all, the person answering these questions might be a
junior sysadmin grudgingly following official policy for the company's
webserver. Here we'd turn it into something like:
_Description: Web notes are no longer supported
This system contains a database for web notes, from an earlier version of
DocBookWiki. These are no longer supported in the current version. To
remove this database (now or later), issue the following command and type
the password for the administrative user of MySQL:
echo "drop database webnotes" | mysql -uroot -p
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package