git: afa1a31005 - main - [phb]: Document Uses=ldap

From: Fernando Apesteguía <fernape_at_FreeBSD.org>
Date: Thu, 09 Feb 2023 17:27:15 UTC
The branch main has been updated by fernape:

URL: https://cgit.FreeBSD.org/doc/commit/?id=afa1a31005978bac63874fff8a1833f69a81dae3

commit afa1a31005978bac63874fff8a1833f69a81dae3
Author:     Fernando Apesteguía <fernape@FreeBSD.org>
AuthorDate: 2023-02-09 15:21:25 +0000
Commit:     Fernando Apesteguía <fernape@FreeBSD.org>
CommitDate: 2023-02-09 17:22:23 +0000

    [phb]: Document Uses=ldap
    
    Chasing changes in
    https://cgit.freebsd.org/ports/commit/?id=6e1233be229212a0496f42d611bd40f3e3a628da
    
    Reviewed by: bofh
    Differential Revision: https://reviews.freebsd.org/D38464
---
 .../en/books/porters-handbook/uses/_index.adoc     | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index 817ed80eb3..e348d7d3ac 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -963,6 +963,28 @@ Fills in the boilerplate for kernel module ports, currently:
 * Handle cross-referencing kernel modules upon installation and deinstallation, using crossref:plist[plist-keywords-kld,`@kld`].
 * If the `debug` argument is given, the port can install a debug version of the module into [.filename]#KERN_DEBUGDIR#/[.filename]#KMODDIR#. By default, `KERN_DEBUGDIR` is copied from `DEBUGDIR` and set to [.filename]#/usr/lib/debug#. The framework will take care of creating and removing any required directories.
 
+[[uses-ldap]]
+== `ldap`
+
+Possible arguments: (none), <version>, client, server
+
+Registers a dependency on package:net/openldap[].
+It uses the specific `<version>` (without the dot notation) if set.
+Otherwise it tries to find the currently installed version.
+If necessary it falls back to the default version found in `bsd.default-versions.mk`.
+`client` specifies a runtime dependency on the client library. This is also the
+default.
+`server` specifies a runtime dependency on the server.
+
+The following variables can be accessed by the port:
+
+`IGNORE_WITH_OPENLDAP`::
+This variable can be defined if the ports does not support one or more versions of OpenLDAP.
+`WITH_OPENLDAP_VER`::
+User defined variable to set OpenLDAP version.
+`OPENLDAP_VER`::
+Detected OpenLDAP version.
+
 [[uses-lha]]
 == `lha`