Issue 8205 - [PATCH] man pages in contrib
Summary: [PATCH] man pages in contrib
Status: VERIFIED FIXED
Alias: None
Product: OpenLDAP
Classification: Unclassified
Component: build (show other issues)
Version: 2.4.41
Hardware: All All
: --- normal
Target Milestone: 2.5.0
Assignee: OpenLDAP project
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-07-26 21:14 UTC by peter@adpm.de
Modified: 2020-10-14 21:06 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 peter@adpm.de 2015-07-26 21:14:13 UTC
Full_Name: Peter Marschall
Version: 2.4.41
OS: Linux
URL: 
Submission from: (NULL) (84.57.119.212)


Hi,

it always troubled me that the modules in contrib/slapd-modules did either not
have a manual page, or - when there was one - did not install it.

This week-end Iat down and tried to fix the issue by
* amending the Makefiles in contrib to also Rdeal with man page in their install
target
* writing some man-pages for contrib modules

You can find them in ther github branch:
  https://github.com/marschap/openldap/tree/contrib-manpages

It differs from today's master by these commits:
* https://github.com/marschap/openldap/commit/25ea4e1e7ab6a6f6a609b70095a0c47919511cd0
  contrib/smbk5pwd: add man page, install it too
* https://github.com/marschap/openldap/commit/16395e3b971e3d1734fc1294b5e9adab568336e1
  contrib/lastbind: install man page
* https://github.com/marschap/openldap/commit/2ede55ce9ada228c7382b5bee9e0d299de7e4b4e
  contrib/passwd/sha2: add man page, install it too
* https://github.com/marschap/openldap/commit/d37b3d2f3e297105f603eccbc5221b5ed411ab48
  contrib/adremap: install man page
* https://github.com/marschap/openldap/commit/e6f3ad1f035f40fd94ac90da14ac8b2cf1687c57
  contrib/allop: install man page
* https://github.com/marschap/openldap/commit/3b417c99028fb37be3f88afc3da751198cc1258a
  contrib/cloak: install man page
* https://github.com/marschap/openldap/commit/9902b56e7830588d761c74a5a5f7b8df70d22a78
  contrib/lastmod: install man page
* https://github.com/marschap/openldap/commit/6590fff13b591cdb481daa38c572c2de83c4c06a
  contrib/nops: install n n page
* https://github.com/marschap/openldap/commit/7f618c17e0f40764fa1590bb9dba5a9e6f6ce063
  contrib/nssov: install man page
* https://github.com/marschap/openldap/commit/b07b66e36ada9c57a85180710b326ed549b7f166
  contrib/passwd: add man page slapd-pw-sha2.5, install it too
* https://github.com/marschap/openldap/commit/ca81d5ef6245ece3609a8708376cb912b6598bd3
  contrib/passwd/totp: add man page, install it too

that change these files
 contrib/slapd-modules/adremap/Makefile            |  14 +-
 contrib/slapd-modules/allop/Makefile              |  14 +-
 contrib/slapd-modules/cloak/Makefile              |  14 +-
 contrib/slapd-modules/lastbind/Makefile           |  14 +-
 contrib/slapd-modules/lastmod/Makefile            |  13 +-
 contrib/slapd-modules/nops/Makefi                 |  14 +-
 contrib/slapd-modules/nssov/Makefile              |  15 +-
 contrib/slapd-modules/passwd/Makefile             |  14 +-
 contrib/slapd-modules/passwd/sha2/Makefile        |  14 +-
 contrib/slapd-modules/passwd/sha2/slapd-pw-sha2.57C7C 118 ++++++++++++++
 contrib/slapd-modules/passwd/slapd-pw-radius.5    | 110 +++++++++++++
 contrib/slapd-modules/passwd/totp/Makefile        |  14 +-
 contrib/slapd-modules/passwd/totp/slapo-totp.5    | 131 ++++++++++++++++
 contrib/slapd-modules/smbk5pwd/Makefile           |  14 +-
 contrib/slapd-modules/smbk5pwd/slapo-smbk5pwd.5   | 179 ++++++++++++++++++++++
 15 files changed, 681 insertions(+), 11 deletions(-)
 create mode 100644 contrib/slapd-modules/passwd/sha2/slapd-pw-sha2.5
 create mode 100644 contrib/slapd-modules/passwd/slapd-pw-radius.5
 create mode 100644 contrib/slapd-modules/passwd/totp/slapo-totp.5
 create mode 100644 contrib/slapd-modules/smbk5pwd/slapo-smbk5pwd.5

I'd appreciate if you include them into OpenLDAP.

The referenced patch files are derived from OpenLDAP Software.
All of the modifications to OpenLDAP Software represented in the following
patch(es) were developed by Peter Marschall <peter@adpm.de>.
I have not assigned rights and/or interest in this work to any party.

The referenced modifications to OpenLDAP Software are subject to the following
notice:
Copyright 2015 Peter Marschall
Redistribution and use in source and binary forms, with or without
modification,
are permitted only as authorizedy y the OpenLDAP Public License.

Thanks in advance
Peter
Comment 1 peter@adpm.de 2015-08-08 18:59:39 UTC
Hi,

I extended the patch series with a manual page for pbkdf2
* https://github.com/marschap/openldap/commit/f63202e8aa68e3391f52d2481f649ca22aeb5ae4
  contrib/passwd/pbkdf2: add man page, install it too

Best
Peter
-- 
Peter Marschall
peter@adpm.de


Comment 2 Howard Chu 2015-10-25 09:28:32 UTC
peter@adpm.de wrote:
> Hi,
>
> I extended the patch series with a manual page for pbkdf2
> * https://github.com/marschap/openldap/commit/f63202e8aa68e3391f52d2481f649ca22aeb5ae4
>    contrib/passwd/pbkdf2: add man page, install it too

Please use format-patch to submit patches, thanks.

-- 
   -- 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 3 Quanah Gibson-Mount 2017-04-03 16:50:09 UTC
moved from Incoming to Documentation
Comment 4 Quanah Gibson-Mount 2017-04-23 21:47:39 UTC
--On Sunday, October 25, 2015 10:28 AM +0000 hyc@symas.com wrote:

> peter@adpm.de wrote:
>> Hi,
>>
>> I extended the patch series with a manual page for pbkdf2
>> *
>> https://github.com/marschap/openldap/commit/f63202e8aa68e3391f52d2481f64
>> 9ca22aeb5ae4 contrib/passwd/pbkdf2: add man page, install it too
>
> Please use format-patch to submit patches, thanks.

If you add .patch to the end of the URL, you can trivially get patches 
already formatted for use with git.  A rather useful trick. ;)

--Quanah



--

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


Comment 5 OpenLDAP project 2017-04-25 18:39:37 UTC
Fixed in master
Comment 6 Quanah Gibson-Mount 2017-04-25 18:39:37 UTC
changed notes
changed state Open to Test
moved from Documentation to Build