From openldap-technical  Thu Nov 16 00:22:28 2023
From: Howard Chu <hyc () symas ! com>
Date: Thu, 16 Nov 2023 00:22:28 +0000
To: openldap-technical
Subject: Re: Transitioning from slapd.conf to slapd.d, best practices for maintaining configuration comments?
Message-Id: <3553537f-757f-66e0-32fe-f0f434d0c8d1 () symas ! com>
X-MARC-Message: https://marc.info/?l=openldap-technical&m=170009416000993

Ben Poliakoff wrote:
> This is more of a practical question than a technical one, but it's pro=
mpted by a technical change: I'm *very* **very** belatedly transitioning =
from flat file
> slapd.conf config to slapd.d/OLC.=C2=A0
>=20
> With flat file configuration, it was straightforward to include text co=
mments (e.g. "# blah blah"), but as far as I know there isn't any sort of=
 analog for
> comments, when using slapd.d. Looking for any tips about how best to an=
notate slapd configuration, in a slapd.d/olc world. Does anyone have a pr=
actice that they
> find works=C2=A0well for them? Do people just maintain separate documen=
ts/wiki pages/etc that describe their servers' configs?

There's no real mechanism for commenting in the config itself. We could a=
dd optional "description" attributes to all of the config objectclasses, =
which would
at least let you keep some information near the relevant locations, but i=
t still wouldn't be the equivalent of line-by-line commenting.

--=20
  -- Howard Chu
  CTO, Symas Corp.           http://www.symas.com
  Director, Highland Sun     http://highlandsun.com/hyc/
  Chief Architect, OpenLDAP  http://www.openldap.org/project/