Issue 7177 - [PATCH] various manpage fixes
Summary: [PATCH] various manpage fixes
Status: VERIFIED FIXED
Alias: None
Product: OpenLDAP
Classification: Unclassified
Component: documentation (show other issues)
Version: 2.4.29
Hardware: All All
: --- normal
Target Milestone: ---
Assignee: OpenLDAP project
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-02-22 13:40 UTC by jvcelak@redhat.com
Modified: 2017-03-29 19:48 UTC (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description jvcelak@redhat.com 2012-02-22 13:40:33 UTC
Full_Name: Jan Vcelak
Version: 2.4.29
OS: Linux
URL: ftp://ftp.openldap.org/incoming/
Submission from: (NULL) (209.132.186.34)


Hello,

I have uploaded two patches with manual page fixes:

ftp://ftp.openldap.org/incoming/jvcelak-20120222-0001-man-add-missing-options-to-the-client-tools.patch

 - typo in '-o' in --help output
 - missing '-C' in ldapsearch and ldapcompare
 - manpages all tools:
   + add -o description (general options)
   + add -N description (reverse DNS SASL host name canonicalization)
 - manpages ldapsearch, ldapcompare:
   + add -C (perform referral chasing)

ftp://ftp.openldap.org/incoming/jvcelak-20120222-0002-man-add-SASL_NOCANON-option-to-ldap.conf-5.patch

 - add SASL_NOCANON option to ldap.conf(5)


The attached files are derived from OpenLDAP Software. All of the modifications
to OpenLDAP Software represented in the uploaded patches were developed by Red
Hat. Red Hat has not assigned rights and/or interest in this work to any party.
I, Jan Vcelak am authorized by Red Hat, my employer, to release this work under
the following terms. 

Red Hat hereby place the following modifications to OpenLDAP Software (and only
these modifications) into the public domain. Hence, these modifications may be
freely used and/or redistributed for any purpose with or without attribution
and/or other notice. 
Comment 1 Howard Chu 2012-02-22 20:32:19 UTC
jvcelak@redhat.com wrote:
> Full_Name: Jan Vcelak
> Version: 2.4.29
> OS: Linux
> URL: ftp://ftp.openldap.org/incoming/
> Submission from: (NULL) (209.132.186.34)
>
>
> Hello,
>
> I have uploaded two patches with manual page fixes:
>
> ftp://ftp.openldap.org/incoming/jvcelak-20120222-0001-man-add-missing-options-to-the-client-tools.patch
>
>   - typo in '-o' in --help output
>   - missing '-C' in ldapsearch and ldapcompare
>   - manpages all tools:
>     + add -o description (general options)
>     + add -N description (reverse DNS SASL host name canonicalization)
>   - manpages ldapsearch, ldapcompare:
>     + add -C (perform referral chasing)

The -C option is deprecated and intentionally undocumented.

-- 
   -- 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 jvcelak@redhat.com 2012-02-23 13:58:10 UTC
> The -C option is deprecated and intentionally undocumented.

OK, I've uploaded updated patches, which exclude '-C':

ftp://ftp.openldap.org/incoming/jvcelak-20120223-0001-man-add-missing-options-to-the-client-tools.patch
ftp://ftp.openldap.org/incoming/jvcelak-20120223-0002-man-add-SASL_NOCANON-option-to-ldap.conf-5.patch

Jan

Comment 3 Howard Chu 2012-02-23 20:30:37 UTC
Jan Vcelak wrote:
>> The -C option is deprecated and intentionally undocumented.
>
> OK, I've uploaded updated patches, which exclude '-C':
>
> ftp://ftp.openldap.org/incoming/jvcelak-20120223-0001-man-add-missing-options-to-the-client-tools.patch
> ftp://ftp.openldap.org/incoming/jvcelak-20120223-0002-man-add-SASL_NOCANON-option-to-ldap.conf-5.patch
>
> Jan
>
Thanks. Some of this overlaps ITS#7152. Will take a look at both to see which 
I like better. ;)

It seems unnecessary to document ldif-wrap in all of the commands, since only 
ldapsearch actually produces LDIF output. The option isn't relevant for any of 
the others.

-- 
   -- 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 4 jvcelak@redhat.com 2012-02-23 22:16:51 UTC
> It seems unnecessary to document ldif-wrap in all of the commands,
> since only
> ldapsearch actually produces LDIF output. The option isn't relevant
> for any of
> the others.

I know. Feel free to modify the changes as you wish. I just wanted
to make the man page consistent across all tools, because the
description of "-o" displayed with "ldaptool --help" is always the
same.

Jan

Comment 5 Hallvard Furuseth 2012-02-23 22:37:12 UTC
On Thu, 23 Feb 2012 20:31:09 GMT, hyc@symas.com wrote:
> It seems unnecessary to document ldif-wrap in all of the commands,
> since only ldapsearch actually produces LDIF output.

No, controls can also request LDIF output.  E.g.
         ldapmodify -e preread -o ldif-wrap=20
wraps after column... 22??  New ITS coming up.

-- 
Hallvard

Comment 6 Howard Chu 2012-02-23 22:44:35 UTC
h.b.furuseth@usit.uio.no wrote:
> On Thu, 23 Feb 2012 20:31:09 GMT, hyc@symas.com wrote:
>> It seems unnecessary to document ldif-wrap in all of the commands,
>> since only ldapsearch actually produces LDIF output.
>
> No, controls can also request LDIF output.  E.g.
>           ldapmodify -e preread -o ldif-wrap=20
> wraps after column... 22??  New ITS coming up.
>
OK, in that case I don't see any reason to tweak that part of the patch.

-- 
   -- 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 7 Howard Chu 2012-02-24 00:59:19 UTC
changed notes
changed state Open to Test
moved from Incoming to Documentation
Comment 8 Quanah Gibson-Mount 2012-02-28 05:12:01 UTC
changed notes
changed state Test to Release
Comment 9 Quanah Gibson-Mount 2012-03-06 00:19:02 UTC
changed notes
changed state Release to Closed
Comment 10 Quanah Gibson-Mount 2012-03-06 00:19:09 UTC
changed notes
Comment 11 jvcelak@redhat.com 2012-04-24 08:32:13 UTC
Hello,

this was not fixed entirely.

> ftp://ftp.openldap.org/incoming/jvcelak-20120223-0002-man-add-SASL_NOCANON-option-to-ldap.conf-5.patch

SASL_NOCANON option is still missing in ldap.conf(5).

Jan

Comment 12 OpenLDAP project 2014-08-01 21:04:11 UTC
added to master, with cleanups
added to RE24
Comment 13 Quanah Gibson-Mount 2017-03-29 19:48:10 UTC
Hi Jan,

I've applied the SASL_NOCANON patch that was missed previously. Thanks for 
the submission!

--Quanah

--

Quanah Gibson-Mount
Product Architect
Symas Corporation
Packaged, certified, and supported LDAP solutions powered by OpenLDAP:
<http://www.symas.com>