[Xapian-discuss] Doc bug for remote database stubs ?
jf at dockes.org
Wed Oct 31 13:21:24 GMT 2012
Olly Betts writes:
> On Tue, Oct 30, 2012 at 09:36:30PM +0100, Jean-Francois Dockes wrote:
> [ remote Xapian and stub files]
> > I'm a bit surprised that nobody ever remarked this, and quite in doubt that
> > I am right, but the fact is, that the current example line does not work
> > and the last one above does...
> I think most people using remote use the TCP variant, and a lot of
> people probably use it directly rather than via a stub file. I guess
> nobody has used the two together before, or at least not from just
> reading the docs.
The ssh variation is extremely handy for a quick test, and needs zero
configuration. Just replace the Xapian directory name with one for an
appropriate stub file and snap! instant remote Recoll (although quite slow).
> Differentiating based on that colon is kind of weird, so especially
> since this isn't actually correctly documented, I'm tempted to deprecate
> that form, and add a "remote-prog" or something as the preferred way to
> do this.
It's your time and your code of course, but this is a really small
weirdness for a little used feature, I feel that a word of explanation
("needs a colon before the command name, don't ask"), and a correct
exemple, would be sufficient.
> Incidentally, I think the reason it's a weird format is just due to the
> history. Originally the testsuite didn't have machinery to fire up
> remote tests over TCP (it's fiddly to do as you have to ensure you start
> it on a port which isn't in use, and tell the client the port number to
> use). So the prog variant was created purely for the test harness, but
> later we realised it was actually useful for things like tunnelling the
> connection. But originally the remote prog backend was probably only
> intended to be used in the testsuite, so a nice syntax wasn't important.
> The "getting started" guide now has automated testing that the code
> examples work and produce the output shown, so we should have fewer
> issues of this sort in that at least.
More information about the Xapian-discuss