Saturday, November 14, 2020

libinotify, add README

The "seafile client doesn't sync files" post on misc@ made me notice
that there's no warning for libinotify-based ports like we have for
glib about increasing fd limits for kqueue file monitoring.
It probably won't help _that_ much but I think it's probably worth
adding a pkg-readme that we can point people to (I've based it on
glib's). I added debug packages while there.

ok?

Index: Makefile
===================================================================
RCS file: /cvs/ports/devel/libinotify/Makefile,v
retrieving revision 1.13
diff -u -p -r1.13 Makefile
--- Makefile 19 Sep 2019 13:33:57 -0000 1.13
+++ Makefile 14 Nov 2020 12:47:13 -0000
@@ -6,7 +6,7 @@ GH_ACCOUNT = libinotify-kqueue
GH_PROJECT = libinotify-kqueue
GH_TAGNAME = 20170711
PKGNAME = libinotify-${GH_TAGNAME}
-REVISION = 0
+REVISION = 1

SHARED_LIBS = inotify 2.1

@@ -18,6 +18,8 @@ MAINTAINER = Kirill Bychkov <kirby@open
PERMIT_PACKAGE = Yes

WANTLIB = pthread
+
+DEBUG_PACKAGES = ${BUILD_PACKAGES}

SEPARATE_BUILD = Yes
CONFIGURE_STYLE = autoreconf
Index: pkg/PLIST
===================================================================
RCS file: /cvs/ports/devel/libinotify/pkg/PLIST,v
retrieving revision 1.3
diff -u -p -r1.3 PLIST
--- pkg/PLIST 19 Sep 2019 13:33:57 -0000 1.3
+++ pkg/PLIST 14 Nov 2020 12:47:13 -0000
@@ -3,7 +3,7 @@ include/inotify/
include/inotify/sys/
include/inotify/sys/inotify.h
lib/inotify/
-lib/inotify/libinotify.a
+@static-lib lib/inotify/libinotify.a
lib/inotify/libinotify.la
@lib lib/inotify/libinotify.so.${LIBinotify_VERSION}
lib/pkgconfig/libinotify.pc
@@ -14,3 +14,4 @@ lib/pkgconfig/libinotify.pc
@man man/man3/inotify_rm_watch.3
@man man/man3/inotify_set_param.3
@man man/man3/libinotify.3
+share/doc/pkg-readmes/${PKGSTEM}
Index: pkg/README
===================================================================
RCS file: pkg/README
diff -N pkg/README
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ pkg/README 14 Nov 2020 12:47:13 -0000
@@ -0,0 +1,12 @@
+$OpenBSD$
+
++-------------------------------------------------------------------------------
+| Running ${PKGSTEM} on OpenBSD
++-------------------------------------------------------------------------------
+
+libinotify uses kqueue(2) to monitor for changed files. This only works
+up to the system's "open file descriptors" limit - if software using
+libinotify needs to handle large directories, the kern.maxfiles
+sysctl(8) should be increased by adding an entry in sysctl.conf(5) and
+the user's login(1) class modified accordingly by bumping the "cur" and
+"max" "openfiles" limit in login.conf(5).

No comments:

Post a Comment