You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@spamassassin.apache.org by bu...@bugzilla.spamassassin.org on 2005/08/18 08:53:50 UTC
[Bug 4543] New: Document procedure for migrating Bayes backends
http://bugzilla.spamassassin.org/show_bug.cgi?id=4543
Summary: Document procedure for migrating Bayes backends
Product: Spamassassin
Version: SVN Trunk (Latest Devel Version)
Platform: All
OS/Version: All
Status: NEW
Severity: trivial
Priority: P1
Component: Documentation
AssignedTo: dev@spamassassin.apache.org
ReportedBy: duncf@debian.org
I've rigged up a patch for adding this to the sa-learn man page, and I'd like to
get it in 3.1, but there is some suggestion that the man page is not the right
place for this.
It needs to be somewhere *other* than the Wiki, as it's a fairly fundamental
issue users are likely to experience as they migrate from the Bayes DBM storage
module to well... anything.
It's in sql/README.bayes, but that's not a great place for it -- users moving
from DBM -> SDBM will want to know how to do it.
So that leaves the README, which is more about getting set up, or the sa-learn
manpage. Man pages probably shouldn't contain HOWTOs, which this is, kinda.
This doesn't really need a review since it's a doc fix, but I'd like to see some
consensus, even if it's lazy consensus, so I'd like some opinions! :-)
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4543] Document procedure for migrating Bayes backends
Posted by bu...@bugzilla.spamassassin.org.
http://bugzilla.spamassassin.org/show_bug.cgi?id=4543
------- Additional Comments From duncf@debian.org 2005-08-17 23:54 -------
Created an attachment (id=3086)
--> (http://bugzilla.spamassassin.org/attachment.cgi?id=3086&action=view)
patch to sa-learn man page
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4543] Document procedure for migrating Bayes backends
Posted by bu...@bugzilla.spamassassin.org.
http://bugzilla.spamassassin.org/show_bug.cgi?id=4543
------- Additional Comments From lwilton@earthlink.net 2005-08-18 00:50 -------
Subject: Re: New: Document procedure for migrating Bayes backends
I think it doesn't matter much where you put it, specifically. What I think
is important is that there is a link or pointer to it in the several places
that people are likely to discover that they can muck around with changing
the backend.
Likely places are Upgrade, a Migration document if there is one, the main
man page, and quite possibly a reference in the main readme.
Assuming that Upgrade ore RelNotes or something now says something like "We
recommend that DBM users switch to SQL using one of the new backends because
it is 7x - 20x faster", I would add the sentence "See x/y/z/README for how
to do this.".
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4543] Document procedure for migrating Bayes backends
Posted by bu...@bugzilla.spamassassin.org.
http://bugzilla.spamassassin.org/show_bug.cgi?id=4543
------- Additional Comments From jm@jmason.org 2005-08-18 09:39 -------
why not in the Wiki? IMO, it's easier to find if
- (a) google will find it
- (b) it's in the FAQ
- (c) it can be pointed at with a one-line, 30-character hyperlink
- (d) it can be pointed to from multiple places
- (e) nobody reads the README or UPGRADE docs _anyway_, they read the FAQ
for example:
Migrating a Bayes database from one format to another is covered
here: http://wiki.apache.org/spamassassin/BayesDbMigration
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4543] Document procedure for migrating Bayes backends
Posted by bu...@bugzilla.spamassassin.org.
http://bugzilla.spamassassin.org/show_bug.cgi?id=4543
duncf@debian.org changed:
What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |RESOLVED
Resolution| |FIXED
------- Additional Comments From duncf@debian.org 2005-08-19 16:12 -------
Committed.
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
[Bug 4543] Document procedure for migrating Bayes backends
Posted by bu...@bugzilla.spamassassin.org.
http://bugzilla.spamassassin.org/show_bug.cgi?id=4543
------- Additional Comments From duncf@debian.org 2005-08-18 17:48 -------
Subject: Re: Document procedure for migrating Bayes backends
I think it's just a minor distinction between "necessary
documentation" that should be in the distribution and "extra
documentation" that should be on the Wiki. Generally the Wiki contains
more "howto"-type stuff and consolidates the documentation together in
a task-oriented manner.
However, as far as I can tell, the method to switch Bayes backends is
not described anywhere. It's certainly not obvious that a --backup and
--restore would do it from the included documentation.
Users that read the included documentation and understand it
thoroughly should not need to read the wiki. I'm not saying we should
remove it from the wiki.
Unless I see some vetos, I'm going to put the documentation in -- doc
fixes are C-T-R in 3.1.
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.