From: Edd Barrett <edd@theunixzoo.co.uk>
Subject: Re: mail/isync: improve an error message
To: ports@openbsd.org
Date: Tue, 9 Jan 2024 15:46:41 +0000

On Tue, Jan 09, 2024 at 03:26:48PM +0000, Klemens Nanni wrote:
> README can always be read in advance, is easy to maintain and, imho, one
> of the first places to look at if you run into ports/package problems.
> 
> This just makes more sense to me.

In that case, here is the first patch I wrote :)


Index: Makefile
===================================================================
RCS file: /cvs/ports/mail/isync/Makefile,v
diff -u -p -r1.57 Makefile
--- Makefile	7 Nov 2023 14:19:36 -0000	1.57
+++ Makefile	9 Jan 2024 13:59:35 -0000
@@ -1,7 +1,7 @@
 COMMENT=	synchronize IMAP4 and maildir mailboxes
 
 DISTNAME=	isync-1.4.4
-REVISION=	2
+REVISION=	3
 
 CATEGORIES=	mail
 SITES=		${SITE_SOURCEFORGE:=isync/}
Index: pkg/PLIST
===================================================================
RCS file: /cvs/ports/mail/isync/pkg/PLIST,v
diff -u -p -r1.10 PLIST
--- pkg/PLIST	10 Mar 2022 12:03:32 -0000	1.10
+++ pkg/PLIST	9 Jan 2024 14:07:44 -0000
@@ -9,5 +9,6 @@ share/doc/isync/ChangeLog
 share/doc/isync/NEWS
 share/doc/isync/README
 share/doc/isync/TODO
+share/doc/pkg-readmes/${PKGSTEM}
 share/examples/isync/
 share/examples/isync/mbsyncrc.sample
Index: pkg/README
===================================================================
RCS file: pkg/README
diff -N pkg/README
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ pkg/README	9 Jan 2024 14:15:49 -0000
@@ -0,0 +1,17 @@
++-------------------------------------------------------------------------------
+| Running ${PKGSTEM} on OpenBSD
++-------------------------------------------------------------------------------
+
+Using XOAUTH2
+=============
+
+If you need to use the `XOAUTH2` authentication mechanism, then you will need
+to install the cyrus-sasl-xoauth2 package:
+
+# pkg_add cyrus-sasl-xoauth2
+
+Failure to do so gives a cryptic error message like:
+
+  IMAP error: selected SASL mechanism(s) not available;
+     selected: XOAUTH2
+     available: SCRAM-SHA-512 SCRAM-SHA-384...

-- 
Best Regards
Edd Barrett

https://www.theunixzoo.co.uk