git: ba5ef9dfa8e5 - stable/15 - bsd.lib.mk: document INTERNALLIB and PRIVATELIB

The branch stable/15 has been updated by kib:

URL: https://cgit.FreeBSD.org/src/commit/?id=ba5ef9dfa8e54f4ee74d85bab0f2cb0ffcca7622

commit ba5ef9dfa8e54f4ee74d85bab0f2cb0ffcca7622
Author:     Konstantin Belousov <kib@FreeBSD.org>
AuthorDate: 2025-11-27 16:41:29 +0000
Commit:     Konstantin Belousov <kib@FreeBSD.org>
CommitDate: 2025-12-01 00:46:09 +0000

    bsd.lib.mk: document INTERNALLIB and PRIVATELIB
    
    (cherry picked from commit e60861eb41ca9d141a0d967db3ecbe2b2909c300)
---
 share/mk/bsd.lib.mk | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/share/mk/bsd.lib.mk b/share/mk/bsd.lib.mk
index 159957b6300b..e3b3d760ff28 100644
--- a/share/mk/bsd.lib.mk
+++ b/share/mk/bsd.lib.mk
@@ -1,3 +1,18 @@
+# If INTERNALLIB is defined, we build lib<name>.a and lib<name>_pie.a,
+# i.e. only static archives without dso, in both non-PIE and PIE variants,
+# suitable for static linking into binaries.
+# INTERNALLIB library headers are not installed.  A component that uses
+# the library should add explicit -I$(LIB<name>DIR) to CFLAGS.
+#
+# If PRIVATELIB is defined, we build and install both libprivate<name>.a
+# and libprivate<name>.so, so the library can be linked dynamically, but
+# cannot be picked up by third-party configure scripts.
+# PRIVATELIB library headers are installed into include/private/<name>.
+#
+# If neither of control variables are defined, we install headers into
+# include/, and both non-pic static and shared libraries under the defined
+# name.
+
 .include <bsd.init.mk>
 .include <bsd.compiler.mk>
 .include <bsd.linker.mk>