Bug#414650: [Pkg-openldap-devel] Bug#414650: slapd: documentation doesn't highlight need to rebuild indexes

[Quanah Gibson-Mount]

--On Tuesday, March 13, 2007 11:57 AM +1100 Geoff Crompton 
<geoff.crompton at strategicdata.com.au> wrote:

> Package: slapd
> Severity: wishlist
>
>
> The slapd.conf man page doesn't document the option 'index'. When that is
> added, please highlight the fact that if index options are altered, you
> must run slapindex.

Indexing behavior is specific to different backends.  You'll see that the 
"index" directive is not even listed in the slapd.conf(5) man page.  If you 
read the man page for the backend you are using, you'll find it listed. 
For example, from the slapd-bdb(5) man page:

index {_attrlist_|default} [pres,eq,approx,sub,_special_]
	      Specify the indexes to maintain for the given attribute (or list
	      of attributes).	Some  attributes  only	support  a  subset  of
	      indexes.	 If only an _attr_ is given, the indices specified for
	      default are maintained.  Note that setting a  default  does  not
	      imply  that  all attributes will be indexed. Also, for best per-
	      formance, an eq  index  should  always  be  configured  for  the
	      objectClass attribute.

	      A  number  of  special  index  parameters may be specified.  The
	      index type sub can be decomposed	into  subinitial,  subany, and
	      subfinal	indices.   The special type nolang may be specified to
	      disallow use of this index by language  subtypes.   The  special
	      type  nosubtypes	may be specified to disallow use of this index
	      by  named  subtypes.    Note:   changing	 index	 settings   in
	      slapd.conf(5)  requires  rebuilding  indices,  see slapindex(8);
	      changing index settings dynamically by LDAPModifying "cn=config"
	      automatically causes rebuilding of the indices online in a back-
	      ground task.


As you can see, it is clearly noted there that changing an index means you 
may need to run slapindex.  I don't see the need for any man page changes 
here.

--Quanah


--
Quanah Gibson-Mount
Principal Software Developer
ITS/Shared Application Services
Stanford University
GnuPG Public Key: http://www.stanford.edu/~quanah/pgp.html