From: espie <espie@openbsd.org>
Date: Fri, 26 Nov 2021 12:08:35 +0000 (+0000)
Subject: document annotation interactions with pkg_mklocatedb
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=4a75a5de97c7b4b60ee138e5449cc6eb761b49e3;p=openbsd

document annotation interactions with pkg_mklocatedb
---

diff --git a/usr.sbin/pkg_add/pkg_create.1 b/usr.sbin/pkg_add/pkg_create.1
index 2271ef8c089..f58f6caa476 100644
--- a/usr.sbin/pkg_add/pkg_create.1
+++ b/usr.sbin/pkg_add/pkg_create.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: pkg_create.1,v 1.121 2021/11/08 13:33:06 espie Exp $
+.\"	$OpenBSD: pkg_create.1,v 1.122 2021/11/26 12:08:35 espie Exp $
 .\"
 .\" Documentation and design originally from FreeBSD. All the code has
 .\" been rewritten since. We keep the documentation's notice:
@@ -21,7 +21,7 @@
 .\" [jkh] Took John's changes back and made some additional extensions for
 .\" better integration with FreeBSD's new ports collection.
 .\"
-.Dd $Mdocdate: November 8 2021 $
+.Dd $Mdocdate: November 26 2021 $
 .Dt PKG_CREATE 1
 .Os
 .Sh NAME
@@ -891,6 +891,14 @@ and
 annotations are used by the debug packages infrastructure to figure out
 which files may contain debug information.
 .Pp
+Some of these annotations define information that are local to each port
+but global to the package ecosystem in general, and thus make it into
+the package locate database by default (for instance: tag, user, and group
+definitions).
+See
+.Xr pkg_mklocatedb 1
+for details.
+.Pp
 See
 .Xr package 5
 for other internal annotations that are automatically added by the
diff --git a/usr.sbin/pkg_add/pkg_mklocatedb.1 b/usr.sbin/pkg_add/pkg_mklocatedb.1
index 9b9b39f751d..752c00ebc20 100644
--- a/usr.sbin/pkg_add/pkg_mklocatedb.1
+++ b/usr.sbin/pkg_add/pkg_mklocatedb.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: pkg_mklocatedb.1,v 1.17 2014/07/13 15:54:28 espie Exp $
+.\"	$OpenBSD: pkg_mklocatedb.1,v 1.18 2021/11/26 12:08:35 espie Exp $
 .\" Copyright (c) 2005-2007 Marc Espie <espie@openbsd.org>
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
@@ -13,7 +13,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: July 13 2014 $
+.Dd $Mdocdate: November 26 2021 $
 .Dt PKG_MKLOCATEDB 1
 .Os
 .Sh NAME
@@ -89,6 +89,15 @@ Include keyword in each object full name.
 This is more accurate, but defeats
 .Xr locate 1
 compression.
+.Pp
+However, note that some meta annotations always make it into the database:
+.Cm @*exec* ,
+.Cm @define-tag ,
+.Cm @newgroup ,
+.Cm @newuser ,
+.Cm @option Ar no-default-conflict
+and
+.Cm @tag .
 .It Fl n
 Do not pipe output to
 .Pa /usr/libexec/locate.mklocatedb