Re: Missing documentation (ITS#1749)

[Kurt@OpenLDAP.org]

I prefer to have each backend documented in a separate man page.
Importance of backends change over time.

Kurt

At 02:40 AM 2002-04-26, masarati@aero.polimi.it wrote:
>Hallvard B Furuseth writes: 
>
>> As you may have guessed, I didn't see Kurt's response before I posted
>> mine.  Anyway, 
>> 
>> I'm converting the documentation from back-<meta,null,perl,sql,tcl>
>> to man pages and moving the back-<passwd/shell> doc to separate pages.
>> I'll leave the back-monitor documentation alone, it is too unfinished. 
>> 
>> A few questions:
>>  
>> - Should I move back-<bdb/ldbm> to separate pages too?  I like their
>>   documentation where it is, in slapd.conf.5.
>
>good point; I'd liek to see them on separate pages as well,
>but for historical reasons and for their importance they're
>fine in the big file ... maybe they could go in separate files
>for reference, with a sort of quick start in slapd.conf 
>
>> - Pierangelo, I'll combine back-meta/Documentation and
>>   librewrite/RATIONALE into one manpage, 
>
>Fine, they are related (and back-meta would be nearly unusable
>without rewriting). 
>
>>   but they have different
>>   copyrights.  The first says 
>> 
>>     Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
>>     COPYING RESTRICTIONS APPLY, see COPYRIGHT file 
>> 
>>     Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it> 
>> 
>>   and the second has a longer copyright statement.  Could you supply
>>   a single copyright statement for the combined file?
>
>Well, the long copyright in back-meta was to acknowledge the
>origing of the inspiration (that is Howard's back-ldap and technical
>discussions); although strongly related, the two things should
>remain separate, at least from an "intellectual" point of view. 
>
>I'll use the copyright of back-meta for librewrite as well (I'll do
>it myself together with some slight improvements I'm thinking about.
>Thanks anyway. 
>
>>   BTW, should the e-mail address above be replaced with
>>   masarati@aero.polimi.it?
>
>No, most (all?) of my work on LDAP is done as a spin-off of my
>cooperation with SysNet, the "Politecnico di Milano" has nothing
>to do with it. 
>
>Note that after back-meta and librewrite were added, their design
>has never been updated (only kept in sync with backend API changes)
>so they might be a little outdated.  librewrite was meant to be
>as much independent from OpenLDAP as possible, to allow its reuse
>in other contexts where string rewrite might be useful; however,
>to better exploit its capabilities in OpenLDAP without excessive
>performance losses, a better integration could be advisable. 
>
>Pierangelo. 
>
>Dr. Pierangelo Masarati               | voice: +39 02 2399 8309
>Dip. Ing. Aerospaziale                | fax:   +39 02 2399 8334
>Politecnico di Milano                 | mailto:pierangelo.masarati@polimi.it
>via La Masa 34, 20156 Milano, Italy   | http://www.aero.polimi.it/~masarati