From owner-freebsd-ports@freebsd.org Tue Jan 3 16:43:21 2017 Return-Path: Delivered-To: freebsd-ports@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id A610AC9DECA for ; Tue, 3 Jan 2017 16:43:21 +0000 (UTC) (envelope-from adamw@adamw.org) Received: from anoxia.adamw.org (anoxia.adamw.org [104.225.8.149]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "anoxia.adamw.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 69E1A1F18 for ; Tue, 3 Jan 2017 16:43:21 +0000 (UTC) (envelope-from adamw@adamw.org) Received: by anoxia.adamw.org (OpenSMTPD) with ESMTPSA id 4655efa8 TLS version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO; Tue, 3 Jan 2017 09:43:14 -0700 (MST) Content-Type: text/plain; charset=us-ascii Mime-Version: 1.0 (Mac OS X Mail 10.2 \(3259\)) Subject: Re: Ports' tips and gotchas From: Adam Weinberger In-Reply-To: Date: Tue, 3 Jan 2017 09:43:12 -0700 Cc: Freebsd Ports Content-Transfer-Encoding: quoted-printable Message-Id: References: To: "Vlad K." X-Mailer: Apple Mail (2.3259) X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 03 Jan 2017 16:43:21 -0000 > On 3 Jan, 2017, at 9:16, Vlad K. wrote: >=20 >=20 > I've submitted a patch for Postgres server ports with a note about = enabling checksumming = (https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D214671). I'm now = preparing to submit a patch with a similar "Nice to know" tip for = Roundcube (changing default_host breaks the user profiles, and how to = fix it). >=20 > Is pkg-message the right place for such tips and gotchas? Do we need a = separate mechanism where users could collate and submit tips they find = important when installing/upgrading/configuring the port (yeah, those = three exact use cases, I'm sure pkg-message is not the best place for = regular usage tips). Aside from UPDATING of course, which is just = supposed to be important notes about one-time updates/upgrades. No, pkg-message is not the right place. pkg-message should be for "Where = do I start?" or for FreeBSD-specific instructions. Tips, gotchas, = interesting discoveries, bugs, foibles, shortcuts, etc. shouldn't go = into the pkg-message. They should be on a blog, on a website, on a wiki, = submitted upstream for inclusion in manpages or README files, etc. pkg-message needs to contain only essential information, otherwise = end-users will start to ignore them. I agree that tips should be shared, = but putting it into SVN isn't the way to go. # Adam --=20 Adam Weinberger adamw@adamw.org https://www.adamw.org