Issue 7335 - Create process for updating man pages to handle both cn=config and slapd.conf configurations
Summary: Create process for updating man pages to handle both cn=config and slapd.conf...
Status: UNCONFIRMED
Alias: None
Product: OpenLDAP
Classification: Unclassified
Component: documentation (show other issues)
Version: 2.4.23
Hardware: All All
: Normal normal
Target Milestone: 2.7.0
Assignee: OpenLDAP project
URL:
Keywords:
: 6277 7425 7865 (view as issue list)
Depends on:
Blocks: 5915
  Show dependency tree / graph
 
Reported: 2012-07-24 18:57 UTC by riggs@umn.edu
Modified: 2022-02-28 17:57 UTC (History)
3 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this issue.
Description riggs@umn.edu 2012-07-24 18:57:43 UTC 
Full_Name: Benjamin Riggs
Version: 2.4.23
OS: http://ftp.scientificlinux.org/linux/scientific/6x/i386/os/Packages/openldap-servers-2.4.23-20.el6.i686.rpm
URL: ftp://ftp.openldap.org/incoming/
Submission from: (NULL) (128.101.155.71)


The slapo-refint man page has only documentation for slapd.conf, not
slapd-config. Normally this wouldn't be a problem, but the configuration
keywords are not the usual map of simply adding 'olc':

refint_attributes is changed to olcRefintAttribute (no 's'!)
refint_nothing is changed to olcRefintNothing
refint_modifiersname is changed to olcRefintModifiersName
Comment 1 Howard Chu 2012-07-25 19:41:00 UTC 
riggs@umn.edu wrote:
> Full_Name: Benjamin Riggs
> Version: 2.4.23
> OS: http://ftp.scientificlinux.org/linux/scientific/6x/i386/os/Packages/openldap-servers-2.4.23-20.el6.i686.rpm
> URL: ftp://ftp.openldap.org/incoming/
> Submission from: (NULL) (128.101.155.71)
> 
> 
> The slapo-refint man page has only documentation for slapd.conf, not
> slapd-config. Normally this wouldn't be a problem, but the configuration
> keywords are not the usual map of simply adding 'olc':
> 
> refint_attributes is changed to olcRefintAttribute (no 's'!)
> refint_nothing is changed to olcRefintNothing
> refint_modifiersname is changed to olcRefintModifiersName

That's true. All of the manpages should be updated for cn=config. In that
respect this ITS can be combined with ITS#7288.

However, we need to decide on how the new information will be presented, to
avoid any unnecessary duplication. It's already quite redundant to maintain
both the cn=config and slapd.conf chapters of the Admin Guide.

Also, the overall issue is an extremely low priority, since all of the schema
definitions can simply be read out of the cn=schema,cn=config entry. The
slapd-config(5) manpage and Admin Guide already note that all of the schema
are present here, so anyone looking for this information should already know
to look there.

--
  -- Howard Chu
  CTO, Symas Corp.           http://www.symas.com
  Director, Highland Sun     http://highlandsun.com/hyc/
  Chief Architect, OpenLDAP  http://www.openldap.org/project/
Comment 2 Quanah Gibson-Mount 2017-03-29 22:51:10 UTC 
moved from Incoming to Documentation
Comment 3 Howard Chu 2021-02-15 12:43:00 UTC 
*** Issue 6277 has been marked as a duplicate of this issue. ***
Comment 4 Howard Chu 2021-02-15 14:22:38 UTC 
*** Issue 7425 has been marked as a duplicate of this issue. ***
Comment 5 Quanah Gibson-Mount 2021-03-09 19:27:07 UTC 
*** Issue 7865 has been marked as a duplicate of this issue. ***